Set Up Deployment to PyPI for ACCESS-Vis Package

[rbeucher]

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:

1. 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.

2. 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.

3. 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.

4. Testing the Workflow

   • Test the GitHub Actions workflow with a test version deployment to TestPyPI to ensure everything is functioning properly before live deployment.

5. 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.
• Organisation recommendations and guidelines can be found here:
  ACCESS-NRI Documentation Guidelines.

[rbeucher]

• Uploaded manually to pypi.
• Set up CD.yml
• Github repo added as trusted publisher on Pypi