Skip to content

Commit d4a6e0b

Browse files
authored
Merge fc1d551 into b80437e
2 parents b80437e + fc1d551 commit d4a6e0b

File tree

3 files changed

+29
-11
lines changed

3 files changed

+29
-11
lines changed

README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,21 @@
1414
:alt: PyPI - Python Version
1515
:target: https://pypi.org/project/pytask
1616

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

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

2323
.. image:: https://img.shields.io/pypi/l/pytask
2424
:alt: PyPI - License
25+
:target: https://pypi.org/project/pytask
2526

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

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

3233
.. image:: https://codecov.io/gh/pytask-dev/pytask/branch/main/graph/badge.svg
3334
:target: https://codecov.io/gh/pytask-dev/pytask
@@ -90,16 +91,15 @@ Installation
9091
.. start-installation
9192
9293
pytask is available on `PyPI <https://pypi.org/project/pytask>`_ and on `Anaconda.org
93-
<https://anaconda.org/pytask/pytask>`_. Install the package with
94+
<https://anaconda.org/conda-forge/pytask>`_. Install the package with
9495

9596
.. code-block:: console
9697
9798
$ pip install pytask
9899
99100
# or
100101
101-
$ conda config --add channels conda-forge --add channels pytask
102-
$ conda install pytask
102+
$ conda install -c conda-forge pytask
103103
104104
.. end-installation
105105

docs/changes.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,17 @@ Changes
44
This is a record of all past pytask releases and what went into them in reverse
55
chronological order. Releases follow `semantic versioning <https://semver.org/>`_ and
66
all releases are available on `PyPI <https://pypi.org/project/pytask>`_ and
7-
`Anaconda.org <https://anaconda.org/pytask/pytask>`_.
7+
`Anaconda.org <https://anaconda.org/conda-forge/pytask>`_.
88

99

10-
0.0.12 - 2020-02-27
10+
0.0.13 - 2021-xx-xx
11+
-------------------
12+
13+
- :gh:`72` adds conda-forge to the README and highlights importance of specifying
14+
dependencies and products.
15+
16+
17+
0.0.12 - 2021-02-27
1118
-------------------
1219

1320
- :gh:`55` implements miscellaneous fixes to improve error message, tests and coverage.

docs/tutorials/how_to_define_dependencies_products.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ How to define dependencies and products
44
To make sure pytask executes all tasks in a correct order, we need to define which
55
dependencies are required and which products are produced by a task.
66

7+
.. important::
8+
9+
If you do not specify dependencies and products as explained below, pytask will
10+
not able to build a graph, a :term:`DAG`, and will not be able to execute all tasks
11+
in the project correctly!
12+
713
The information on dependencies and products can be attached to a task function with
814
special markers. Let us have a look at some examples.
915

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

61+
.. important::
62+
63+
The two markers, ``pytask.mark.depends_on`` and ``pytask.mark.produces``, cannot be
64+
used interchangeably! Use the first for dependencies and the latter for products.
65+
5566

5667
Conversion
5768
----------

0 commit comments

Comments
 (0)