## How to release

#### Update version number

We use the tool [bumpversion](https://github.com/peritus/bumpversion) to synchronize the version number
across different files:

    bumpversion --verbose --config-file devtools/bumpversion.cfg  patch
    git push origin
    git push origin --tags

#### Publish on Pypi



#### Publish Documentation


#### Publish on Conda


1. Build the package (inside `conda` directory)

    `conda build --python 2.7 --python 3.3 --python 3.4 --python 3.5 -c bioconda -c mdanalysis pbxplore`


2. The path of the created archive will be given at the end of the process


3. Convert it for all plateforms (where `X.X.X` is the pbxplore version and `YY` is the Python version)

    `conda convert --platform all /path/to/archive/pbxplore-X.X.X-pyYY_0.tar.bz2`


4. Upload it to anaconda

    `anaconda upload /path/to/archive/pbxplore-X.X.X-pyYY_0.tar.bz2`


This has to be done for each package created.

## How to release

Before any release, double-check all tests had run successfully.

#### Update version number

We use the tool [bumpversion](https://github.com/peritus/bumpversion) to synchronize the version number
across different files:

    bumpversion --verbose --config-file devtools/bumpversion.cfg  patch
    git push origin
    git push origin --tags

#### Publish on PyPI

Initial setup

- Create an account on PyPI and create a projet (here [pbxplore](https://pypi.python.org/pypi/pbxplore)).

- Create a .pypirc files into your HOME directory with the following lines :

        [distutils]
        index-servers = pypi

        [pypi]
        repository=https://pypi.python.org/pypi
        username=your_username

- Prepare package files (at minimum `setup.py`, `setup.cfg`, `README.md`, `MANIFEST.in` and `LICENSE.txt`).

- Register package to PyPI :

        python setup.py register -r pypi



Build and upload package to PyPI:

    python setup.py sdist upload

Enter your password when required.

#### Publish Documentation


#### Publish on Conda


1. Build the package (inside `conda` directory)

    `conda build --python 2.7 --python 3.3 --python 3.4 --python 3.5 -c bioconda -c mdanalysis pbxplore`


2. The path of the created archive will be given at the end of the process


3. Convert it for all plateforms (where `X.X.X` is the pbxplore version and `YY` is the Python version)

    `conda convert --platform all /path/to/archive/pbxplore-X.X.X-pyYY_0.tar.bz2`


4. Upload it to anaconda

    `anaconda upload /path/to/archive/pbxplore-X.X.X-pyYY_0.tar.bz2`


This has to be done for each package created.

Add doc for PyPI release
Add doc for PyPI release
