Installation¶
pytask is available on PyPI and conda-forge.
Recommended¶
We recommend using modern package managers for faster and more reliable dependency management:
$ uv add pytask
or
$ pixi add pytask
Verify the installation by displaying the help page listing all available commands and some options.
$ pytask --help
<center>pytask <span class="termynal-dim">v0.5.3</span></center>
Usage: <b>pytask [OPTIONS] [COMMAND] [PATHS]</b>
<span class="termynal-dim">Manage your tasks with pytask.</span>
<font color="#5f5f5f">╭─</font> Commands <font color="#5f5f5f">────────────────────────────────────────────────────────────╮</font>
<font color="#5f5f5f">│</font> <span class="termynal-command">build *</span> Collect tasks, execute them and report the results. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> <span class="termynal-command">clean </span> Clean the provided paths by removing files unknown to pytask. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> <span class="termynal-command">collect</span> Collect tasks and report information about them. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> <span class="termynal-command">dag </span> Create a visualization of the directed acyclic graph. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> <span class="termynal-command">markers</span> Show all registered markers. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> <span class="termynal-command">profile</span> Show information about resource consumption <font color="#5f5f5f">│</font>
<font color="#5f5f5f">╰───────────────────────────────────────────────────────────────────────╯</font>
<font color="#5f5f5f">╭─</font> Options <font color="#5f5f5f">─────────────────────────────────────────────────────────────╮</font>
<font color="#5f5f5f">│</font> <span class="termynal-option">--version</span> Show the version and exit. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> <span class="termynal-switch">-h</span> <span class="termynal-option">--help</span> Show this message and exit. <font color="#5f5f5f">│</font>
<font color="#5f5f5f">╰───────────────────────────────────────────────────────────────────────╯</font>
<p align="right"><font color="#cd3131">♥</font> <a style="color: #f2f2f2" href="https://pytask-dev.readthedocs.io">https://pytask-dev.readthedocs.io</a> </p>
For command-specific help, type
$ pytask <command-name> --help
Non-Windows platforms have automatic color support. On Windows, use Windows Terminal, which you can install from the Microsoft Store.