We need to automate the deployment of the ACCESS-Vis package to PyPI. The deployment process should be handled via GitHub Actions as much as possible to ensure smooth and automatic updates whenever a new release is created.
Action Required:
Set Up GitHub Action for PyPI Deployment
Create a GitHub Actions workflow that triggers deployment to PyPI upon pushing a new version tag or release.
Ensure the workflow includes steps to:
Build the package (using tools like setuptools or poetry).
Upload the package to PyPI using twine.
PyPI Credentials
Store the PyPI credentials (username and API token) as GitHub repository secrets (e.g., PYPI_USERNAME and PYPI_API_TOKEN).
Configure the workflow to use these secrets securely during deployment.
Versioning Strategy
Ensure that the workflow increments the version number correctly based on Git tags or releases in GitHub.
Add instructions in the README.md or CONTRIBUTING.md for maintaining and tagging new versions.
Testing the Workflow
Test the GitHub Actions workflow with a test version deployment to TestPyPI to ensure everything is functioning properly before live deployment.
Documentation
Update the README.md with installation instructions from PyPI, and mention the automated deployment process in the repository documentation.
Additional Resources:
Information on how to set up the deployment can be found in the access-med-utils repository.
Set Up Deployment to PyPI for ACCESS-Vis Package
Description:
We need to automate the deployment of the
ACCESS-Vis
package to PyPI. The deployment process should be handled via GitHub Actions as much as possible to ensure smooth and automatic updates whenever a new release is created.Action Required:
Set Up GitHub Action for PyPI Deployment
setuptools
orpoetry
).twine
.PyPI Credentials
PYPI_USERNAME
andPYPI_API_TOKEN
).Versioning Strategy
README.md
orCONTRIBUTING.md
for maintaining and tagging new versions.Testing the Workflow
Documentation
README.md
with installation instructions from PyPI, and mention the automated deployment process in the repository documentation.Additional Resources:
access-med-utils
repository.ACCESS-NRI Documentation Guidelines.