Skip to content

Add conda-forge to README and change wording in docs. #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 7, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,21 @@
:alt: PyPI - Python Version
:target: https://pypi.org/project/pytask

.. image:: https://anaconda.org/pytask/pytask/badges/version.svg
:target: https://anaconda.org/pytask/pytask
.. image:: https://img.shields.io/conda/vn/conda-forge/pytask.svg
:target: https://anaconda.org/conda-forge/pytask

.. image:: https://anaconda.org/pytask/pytask/badges/platforms.svg
:target: https://anaconda.org/pytask/pytask
.. image:: https://img.shields.io/conda/pn/conda-forge/pytask.svg
:target: https://anaconda.org/conda-forge/pytask

.. image:: https://img.shields.io/pypi/l/pytask
:alt: PyPI - License
:target: https://pypi.org/project/pytask

.. image:: https://readthedocs.org/projects/pytask-dev/badge/?version=latest
:target: https://pytask-dev.readthedocs.io/en/latest

.. image:: https://github.com/pytask-dev/pytask/workflows/Continuous%20Integration%20Workflow/badge.svg?branch=main
:target: https://github.com/pytask-dev/pytask/actions?query=branch%3Amain
.. image:: https://img.shields.io/github/workflow/status/pytask-dev/pytask/Continuous%20Integration%20Workflow/main
:target: https://github.com/pytask-dev/pytask/actions?query=branch%3Amain

.. image:: https://codecov.io/gh/pytask-dev/pytask/branch/main/graph/badge.svg
:target: https://codecov.io/gh/pytask-dev/pytask
Expand Down Expand Up @@ -90,16 +91,15 @@ Installation
.. start-installation

pytask is available on `PyPI <https://pypi.org/project/pytask>`_ and on `Anaconda.org
<https://anaconda.org/pytask/pytask>`_. Install the package with
<https://anaconda.org/conda-forge/pytask>`_. Install the package with

.. code-block:: console

$ pip install pytask

# or

$ conda config --add channels conda-forge --add channels pytask
$ conda install pytask
$ conda install -c conda-forge pytask

.. end-installation

Expand Down Expand Up @@ -181,6 +181,10 @@ License

pytask is distributed under the terms of the `MIT license <LICENSE>`_.


Acknowledgment
--------------

The license also includes a copyright and permission notice from pytest since some
modules, classes, and functions are copied from pytest. Not to mention how pytest has
inspired the development pytask in general. Without the amazing work of Holger Krekel
Expand Down
11 changes: 9 additions & 2 deletions docs/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,17 @@ Changes
This is a record of all past pytask releases and what went into them in reverse
chronological order. Releases follow `semantic versioning <https://semver.org/>`_ and
all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
`Anaconda.org <https://anaconda.org/pytask/pytask>`_.
`Anaconda.org <https://anaconda.org/conda-forge/pytask>`_.


0.0.12 - 2020-02-27
0.0.13 - 2021-xx-xx
-------------------

- :gh:`72` adds conda-forge to the README and highlights importance of specifying
dependencies and products.


0.0.12 - 2021-02-27
-------------------

- :gh:`55` implements miscellaneous fixes to improve error message, tests and coverage.
Expand Down
11 changes: 11 additions & 0 deletions docs/tutorials/how_to_define_dependencies_products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ How to define dependencies and products
To make sure pytask executes all tasks in a correct order, we need to define which
dependencies are required and which products are produced by a task.

.. important::

If you do not specify dependencies and products as explained below, pytask will
not able to build a graph, a :term:`DAG`, and will not be able to execute all tasks
in the project correctly!

The information on dependencies and products can be attached to a task function with
special markers. Let us have a look at some examples.

Expand Down Expand Up @@ -52,6 +58,11 @@ Most tasks have dependencies. Similar to products, you can use the
Use ``depends_on`` as a function argument to work with the path of the dependency and,
for example, load the data.

.. important::

The two markers, ``pytask.mark.depends_on`` and ``pytask.mark.produces``, cannot be
used interchangeably! Use the first for dependencies and the latter for products.


Conversion
----------
Expand Down