Skip to content

Commit

Permalink
Merge pull request #63 from LUMC/conda
Browse files Browse the repository at this point in the history
Add information on how to install on conda.
  • Loading branch information
rhpvorderman committed Mar 5, 2019
2 parents 93de47c + fb39629 commit 7829bd0
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 3 deletions.
8 changes: 6 additions & 2 deletions .github/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@ Release checklist
- [ ] Set version to a stable number.
- [ ] Change current development version in `HISTORY.rst` to stable version.
- [ ] Merge the release branch into `master`
- [ ] Create a test pypi package from the release branch. ([Instructions.](
- [ ] Create a test pypi package from the master branch. ([Instructions.](
https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives
))
- [ ] Install the packages from the test pypi repository to see if they work.
- [ ] Created an annotated tag with the stable version number. Include changes
from history.rst.
- [ ] Push tag to remote.
- [ ] Push tested packages to pypi
- [ ] merge `master` branch back into `develop`.
- [ ] Add updated version number to develop
- [ ] Add updated version number to develop
- [ ] Update the package on bioconda
- [ ] Build the new tag on readthedocs. Only build the last patch version of
each minor version. So `1.1.1` and `1.2.0` but not `1.1.0`, `1.1.1` and `1.2.0`.
4 changes: 3 additions & 1 deletion HISTORY.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ Changelog
.. NOTE: This document is user facing. Please word the changes in such a way
.. that users understand how the changes affect the new version.
version 1.2.0
version 1.2.0-dev
---------------------------
+ Added ``--kwd`` as alias for ``--keep-workflow-wd``. Notify the user of
deletion of temporary directories and logs.
+ Released pytest-workflow as a `conda package on bioconda
<https://bioconda.github.io/recipes/pytest-workflow/README.html>`_.

version 1.1.0
---------------------------
Expand Down
14 changes: 14 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,18 @@ pytest-workflow
:target: https://pypi.org/project/pytest-workflow/
:alt:

.. image:: https://img.shields.io/conda/v/bioconda/pytest-workflow.svg
:target: https://https://bioconda.github.io/recipes/pytest-workflow/README.html
:alt:

.. image:: https://img.shields.io/pypi/pyversions/pytest-workflow.svg
:target: https://pypi.org/project/pytest-workflow/
:alt:

.. image:: https://img.shields.io/pypi/l/pytest-workflow.svg
:target: https://github.com/LUMC/pytest-workflow/blob/master/LICENSE
:alt:

.. image:: https://api.codacy.com/project/badge/Grade/f8bc14b0a507429eac7c06194fafcd59
:target: https://www.codacy.com/app/LUMC/pytest-workflow?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=LUMC/pytest-workflow&amp;utm_campaign=Badge_Grade
:alt:
Expand Down Expand Up @@ -41,6 +49,12 @@ and 3.7. Python 2 is not supported.
- Create a ``tests`` directory in the root of your repository.
- Create your test yaml files in the ``tests`` directory.

Pytest-workflow is also available as a `conda package on bioconda
<https://bioconda.github.io/recipes/pytest-workflow/README.html>`_. Follow
`these instructions <https://bioconda.github.io/index.html#set-up-channels>`_
to set up channels properly in order to use bioconda. After that ``conda
install pytest-workflow`` can be used to install pytest-workflow.

Quickstart
==========

Expand Down
8 changes: 8 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,11 @@ On Ubuntu or Debian:
environment will not work with ``pytest-workflow`` because this will start
the python2 version of ``pytest``. This is because python2 is the default
python on any distribution released before January 1st 2020.

Pytest-workflow is also available as a `conda package on bioconda
<https://bioconda.github.io/recipes/pytest-workflow/README.html>`_.
To install with conda:

- `Set up conda to use the bioconda channel
<https://bioconda.github.io/index.html#set-up-channels>`_
- ``conda install pytest-workflow``
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Development Status :: 5 - Production/Stable",
"License :: OSI Approved :: "
"GNU Affero General Public License v3 or later (AGPLv3+)",
"Framework :: Pytest",
Expand Down

0 comments on commit 7829bd0

Please sign in to comment.