This document is only relevant for maintainers of openPMD-viewer. It explains how to create a new release. In future versions of this packages, some of the steps below will be automatized.
Make sure that your local environment is ready for a full release on PyPI and conda. In particular:
- you should install the packages
pypandoc,twine,conda-buildandanaconda-client - you should have a registered account on PyPI and test PyPI, and your
$HOMEshould contain a file.pypircwhich contains the following text:
[distutils] index-servers= pypitest pypi
[pypitest] repository = https://testpypi.python.org/pypi username =
[pypi] repository = https://pypi.python.org/pypi username =
- you should have a registered account on [Anaconda.org](https://anaconda.org/)
## Creating a release on Github
- Make sure that the version number in `setup.py`
corresponds to the new release, and that the corresponding changes have been
documented in `CHANGELOG.md`.
- If everything works fine, then merge the `dev` version into `master`
and upload it to Github:
git checkout master git merge dev git push
- Create a new release through the graphical interface on Github
## Uploading the package to PyPI
- Upload the package to [PyPI](https://pypi.python.org/pypi):
rm -rf dist python setup.py sdist bdist_wheel twine upload dist/* -r pypi
(NB: You can also first test this by uploading the package to
[test PyPI](https://testpypi.python.org/pypi) ; to do so, simply
replace `pypi` by `pypitest` in the above set of commands)
## Uploading the package to Anaconda.org
- `cd` into the folder `conda_recipe` and make sure that the version
number in `meta.yaml` matches the current version.
- Still in the folder `conda_recipe`, build the package for python 2.7
and python 3.5, and convert them for all available OS, by using the
following commands
conda build --python=2.7 .
conda build --python=3.5 .
conda convert
- Upload the different versions to Anaconda.org
anaconda login anaconda upload osx-64/* anaconda upload linux-64/* anaconda upload linux-32/*