Skip to content
Matthew Gilbert edited this page Dec 1, 2016 · 5 revisions

Release Notes

  • Ensure working directory is clean
  • Check pep8: make lint

Test

  • Create a test environment: conda create -n "pdblp_0.1.1-test" pandas sphinx
  • 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 pdblp/_version.py and commit: git commit -m 'Updated _version.py for upcoming release'
  • Append -dev to __version__ in _version.py
  • Test submission to PyPI: python setup.py sdist upload -r pypitest
  • Remove -dev from __version__ in _version.py
  • Pip install package into pdblp_0.1.1-test: pip install -i https://testpypi.python.org/pypi pdblp==0.1.1-dev

Tag and deploy

  • Make an empty commit: git commit --allow-empty -m 'RLS: v0.1.1'
  • Tag the commit using an annotated tag. 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, add CHANGELOG into release notes
  • Release to PyPI:

PyPI submission

  • python setup.py sdist upload -r pypi
Clone this wiki locally