Skip to content

Commit

Permalink
Add PyPI release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dhimmel committed Mar 26, 2017
1 parent 2ea50a2 commit a68f28c
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,13 @@ networkx.descendants(graph, 'TAXRANK:0000006')

## Installation

The latest version of the package can be installed using `pip` with:
The recommended approach is to install the latest release from PyPI using:

```sh
pip install obonet
```

However, if you'd like to install the most recent version from GitHub, use:

```sh
pip install git+https://github.com/dhimmel/obonet.git#egg=obonet
Expand All @@ -57,3 +63,22 @@ pip install git+https://github.com/dhimmel/obonet.git#egg=obonet
We welcome feature suggestions and community contributions.
Currently, only reading OBO files is supported.
Please open an issue if you're interested in writing OBO files in Python.

## Release instructions

This section is only relevant for project maintainers.
Travis CI deployments are used to upload releases to [PyPI](https://pypi.org/project/hetio).
To create a new release, do the following:

1. Bump the `__version__` in [`obonet/__init__.py`](obonet/__init__.py).

3. Run the following commands:

```sh
TAG=v`python setup.py --version`
git add obonet/__init__.py
git commit --message="Upgrade to $TAG"
git push
git tag --annotate $TAG --message="Upgrade to $TAG"
git push --tags
```
2 changes: 1 addition & 1 deletion obonet/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
from .read import read_obo

__version__ = '0.1.0'
__version__ = '0.2.0'

0 comments on commit a68f28c

Please sign in to comment.