Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deploy cladetime to PyPi #80

Open
4 tasks done
bsweger opened this issue Jan 8, 2025 · 2 comments
Open
4 tasks done

Deploy cladetime to PyPi #80

bsweger opened this issue Jan 8, 2025 · 2 comments
Assignees

Comments

@bsweger
Copy link
Collaborator

bsweger commented Jan 8, 2025

Background

Cladetime is working as intended when installed via GitHub. Thus, publishing the package to PyPI isn't required, but it's a good goal and lends legitimacy to the work.

Definition of done

  • Cladetime is available for install on PyPI
  • The Cladetime repo has a GitHub action that automates publishing releases to PyPI
  • More than one person in the Reich Lab has a PyPI account and is added as a Cladetime package owner
  • All docs with Cladetime install instructions are updated
@bsweger bsweger added this to Lab Work Jan 8, 2025
@bsweger bsweger self-assigned this Jan 8, 2025
@bsweger bsweger converted this from a draft issue Jan 8, 2025
@bsweger bsweger added this to the Variant Nowcast milestone Jan 8, 2025
@bsweger
Copy link
Collaborator Author

bsweger commented Jan 9, 2025

Will be adding a series of comments to document the process of publishing to PyPI as we learn about it (so we have some artifacts and notes when it's time to incorporate PyPI info into the Hubverse dev docs).

First set of process notes:

  • We will use a combination of GitHub actions + PyPI trusted publisher to automate the process of pushing a release to PyPI

  • Prerequisites for the above:

    • Create an environment in the package's GitHub repo. This environment name will be used when setting up a trusted publisher on PyPI. PyPI requires that deployments be manually approved when publishing via GitHub. Accomplish this by adding a deployment protection rule to the environment.

    Image

    Image

@bsweger
Copy link
Collaborator Author

bsweger commented Jan 9, 2025

This PR adds setuptools_scm to Cladetime...a handy tool for automatically versioning Python packages (including feature branches) in a way that complies with PEP 440
#84

@bsweger bsweger moved this from In Progress to Ready for Review in Lab Work Jan 13, 2025
@bsweger bsweger moved this from Ready for Review to Done in Lab Work Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant