Releasing Versions

This page documents setting up a new release

PyPI via Tagged Release

Any collaborator of this repository can setup a new release to PyPI using tagged releases. You don't need to be a PyPI maintainer as the GitHub action makes use of a PyPI token.

1. Setup a PR to a) update version, and b) update CHANGELOG
2. After CI checks are completed, this PR can be merged
3. Tag a new release on GitHub using the standard major,minor,bug fix version system such as v0.5.2

This will cause the CI to run and once passed it will publish the new package to PyPI using flit

[Review and Deprecate Below]

PyPI

To issue a new release of QuantEcon.py through PyPI you should follow these steps:

You will need to be a PyPI maintainer of the package to make updates

1. Checkout new-release branch
2. Update version number in setup.py and run python setup.py install to update quantecon/versions.py
3. Commit changes, push to Github, and setup PR
4. After CI has passed checks, merge the PR
5. Checkout master branch and git pull
6. Go to GitHub and setup a new release using tag convention {{ version_number }} (matching the version number)
7. Fill in description of release from running https://github.com/QuantEcon/QuantEcon.py/wiki/Generating-CHANGELOG.md-file locally.
8. Run python setup.py sdist bdist_wheel
9. Run twine upload dist/*

Conda Forge