In its highest aspirations, pytask tries to be pytest as a build system. It’s main purpose is to facilitate reproducible research by automating workflows in research projects. Its features include:
Automatic discovery of tasks.
Lazy evaluation. If a task, its dependencies, and its products have not changed, do not execute it.
Debug mode. Jump into the debugger if a task fails, get feedback quickly, and be more productive.
Select tasks via expressions. Run only a subset of tasks with expressions and marker expressions known from pytest.
Easily extensible with plugins. pytask is built on top of pluggy, a plugin management framework, which allows you to adjust pytask to your needs. Plugins are available for parallelization, LaTeX, R, and Stata and more can be found here. Read in this tutorial how to use and create plugins with a cookiecutter.
Installation
pytask is available on PyPI and on Anaconda.org. Install the package with
$ pip install pytaskor
$ conda install -c conda-forge pytaskColor support is automatically available on non-Windows platforms. On Windows, please, use Windows Terminal which can be, for example, installed via the Microsoft Store.
To quickly set up a new project, use the cookiecutter-pytask-project template or start from other templates or example projects.
Usage
A task is a function which is detected if the module and the function name are prefixed with task_. Here is an example.
# Content of task_hello.py.
import pytask
@pytask.mark.produces("hello_earth.txt")
def task_hello_earth(produces):
produces.write_text("Hello, earth!")Here are some details:
Dependencies and products of a task are tracked via markers. For dependencies use @pytask.mark.depends_on and for products use @pytask.mark.produces. Use strings and pathlib.Path to specify the location. Pass multiple dependencies or products as a list or a dictionary for positional or key-based access.
With produces (and depends_on) as function arguments, you get access to the dependencies and products inside the function via pathlib.Path objects. Here, produces holds the path to "hello_earth.txt".
To execute the task, enter pytask on the command-line
Documentation
The documentation can be found under https://pytask-dev.readthedocs.io/en/latest with tutorials and guides for best practices.
Changes
Consult the release notes to find out about what is new.
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 of pytask in general. Without the amazing work of Holger Krekel and pytest’s many contributors, this project would not have been possible. Thank you!
Citation
If you rely on pytask to manage your research project, please cite it with the following key to help others to discover the tool.
@Unpublished{Raabe2020,
Title = {A Python tool for managing scientific workflows.},
Author = {Tobias Raabe},
Year = {2020},
Url = {https://github.com/pytask-dev/pytask}
}1 maintainer
Metadata
1 maintainer
Release files for pytask 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pytask-0.1.7.tar.gz | 77.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pytask-0.1.7-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 167.7 kB
Release files / pytask-0.1.7.tar.gz
| Download URL | pytask-0.1.7.tar.gz |
|---|---|
| Size | 77.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5db6642008954a97b3f5dd7d23fd18f6b655102c42a974c753d4d5133266b643
|
|
BLAKE2b-256 checksum How to use checksums |
c4c254eed49e315b9bc3567ecb91453c2dabecf6a9d02db9a746d5d261d145d8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10
|
Release files / pytask-0.1.7-py3-none-any.whl
| Download URL | pytask-0.1.7-py3-none-any.whl |
|---|---|
| Size | 90.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e810a958187fc31e9bad493b9bc868098e42c2ad7fb7eda2ff8a6afbfa5d71cb
|
|
BLAKE2b-256 checksum How to use checksums |
0cdd4096322fa950099e3a374bb6ccdabdfe4537145ff52a1e8c7c0c4ba06b8f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10
|
