Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.26 KB

DEVELOPER_NOTES.md

File metadata and controls

35 lines (26 loc) · 1.26 KB

mpc-public: Developer Notes

Developing locally

Before pushing the new version to PyPI you may want to develop and test the new code on your local machine.

# Create a new conda environment
conda create -n mpc-orb-public python=3.11
conda activate mpc-orb-public
cd mpc_orb
python3 -m pip install -e .'[test]'

Pushing to PyPI

Release Version: pyproject.toml

You need to increment the version in pyproject.toml.

  • This controls the version number uploaded and made available on PyPI
  • If you don't increment the version (e.g. from 'v0.0.5' to 'v0.0.6') the upload tp PyPI will likely fail

GitHub Action

The GitHub action is triggered when you manually create a release.
Here’s a step by step: