diff --git a/README.rst b/README.rst index de5e40c7..d47d3e5b 100644 --- a/README.rst +++ b/README.rst @@ -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 @@ -90,7 +91,7 @@ Installation .. start-installation pytask is available on `PyPI `_ and on `Anaconda.org -`_. Install the package with +`_. Install the package with .. code-block:: console @@ -98,8 +99,7 @@ pytask is available on `PyPI `_ and on `Anacond # or - $ conda config --add channels conda-forge --add channels pytask - $ conda install pytask + $ conda install -c conda-forge pytask .. end-installation @@ -181,6 +181,10 @@ License pytask is distributed under the terms of the `MIT 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 diff --git a/docs/changes.rst b/docs/changes.rst index 39e89c65..307e35ca 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -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 `_ and all releases are available on `PyPI `_ and -`Anaconda.org `_. +`Anaconda.org `_. -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. diff --git a/docs/tutorials/how_to_define_dependencies_products.rst b/docs/tutorials/how_to_define_dependencies_products.rst index c20f0b79..56a4e0d1 100644 --- a/docs/tutorials/how_to_define_dependencies_products.rst +++ b/docs/tutorials/how_to_define_dependencies_products.rst @@ -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. @@ -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 ----------