diff --git a/.gitignore b/.gitignore index e14e625..56dee82 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,8 @@ dist/ .cache .pytest_cache/ .ipynb_checkpoints/ +env/ +pip-wheel-metadata/ # System specific files diff --git a/README.md b/README.md index 8b13160..9b39a44 100644 --- a/README.md +++ b/README.md @@ -80,21 +80,28 @@ 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`](https://github.com/dhimmel/obonet/blob/master/obonet/__init__.py). - -3. Run the following commands: - - ```sh - TAG=v`python setup.py --version` - git add obonet/__init__.py - git commit --message="Upgrade version to $TAG" - git push - git tag --annotate $TAG --message="Release $TAG" - git push --tags - ``` +## Develop + +Some development commands: + +```bash +# create virtual environment +python3 -m venv ./env + +# activate virtual environment +source env/bin/activate + +# editable installation for development +pip install --editable ".[dev]" + +# install pre-commit hooks +pre-commit install + +# run all pre-commit checks +pre-commit run --all + +# run tests +pytest +``` + +Maintainers can make a new release at .