Home

Release Notes

• Ensure working directory is clean
• Check pep8: make lint
• Update CHANGELOG with summary, commit

Test

• Create a test environment, e.g.:

conda create -n "pdblp_0.1.1-test" pandas sphinx
conda install -n "pdblp_0.1.1-test" -c conda-forge pyparsing=2.2.0

• Activate the environment: source activate pdblp_0.1.1-test
• Run tests: make test

For docs (if they have been changed)

• From pdblp/doc/ run make html
• Serve documentation and inspect cd _build/html/ && python -m http.server
• Deploy using make github

Test PyPI

• Bump __version__ and append -dev in _version.py
• Test submission to PyPI: python setup.py sdist upload -r pypitest
• Pip install package into conda environment, e.g. pip install -i https://testpypi.python.org/pypi pdblp==0.1.1-dev
• Remove -dev from __version__ in _version.py
• Commit: git commit -m 'Update version to BLANK for upcoming release'

Tag and deploy

• Make an empty commit, e.g. git commit --allow-empty -m 'RLS: v0.1.1'
• Tag the commit using an annotated tag, e.g. git tag -a v0.1.1 -m "Version 0.1.1"
• Push commits git push
• Push the tag! git push --tags
• Create new release at https://github.com/matthewgilbert/pdblp/releases, copy CHANGELOG into release notes
• Release to PyPI:

PyPI submission

• python setup.py sdist upload -r pypi