https://github.com/mdanalysis/pypi-deployment
Reusable github action to package, deploy and and check code to PyPi & TestPyPi
https://github.com/mdanalysis/pypi-deployment
Last synced: 4 months ago
JSON representation
Reusable github action to package, deploy and and check code to PyPi & TestPyPi
- Host: GitHub
- URL: https://github.com/mdanalysis/pypi-deployment
- Owner: MDAnalysis
- License: mit
- Created: 2023-08-23T11:37:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-01T08:40:19.000Z (almost 2 years ago)
- Last Synced: 2024-10-29T17:34:58.801Z (over 1 year ago)
- Size: 23.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pypi-deployment
A reusable github action to package, deploy and and check code to PyPi & TestPyPi
## Basic usage
Please see [action.yaml](action.yaml) for all details.
The following options can be passed:
1. `test_submission`: Bool, if true the package will be uploaded to TestPyPi instead of PyPi (default: false)
2. `wheels`: Bool, if true wheels will be created and uploaded (default: true)
3. `tests`: Bool, if true there will be an attempt to pull down the newly uploaded package and run tests. Please note this assumes testing via `pytest --pyargs inputs.package_name` (default: true)
4. `package_name`: Name of package on PyPi, only needed if testing package post-upload. Used for pip installing (default: 'MDAnalysis')
5. `module_name`: Name of package directory, only needed if testing package post-upload. Used for pytest pyargs. If unset will use `package_name` (default: null)
6. `test_deps:` : Extra dependencies to install for testing the new package. (default `pytest`).
### Example
An example of how to use this workflow can be seen in [this action file](https://github.com/MDAnalysis/mda-xdrlib/blob/main/.github/workflows/deploy.yaml).
## Note
This currently only support pure Python packages. Future work will switch this action to using cibuildwheels.