Installation#
pytask is available on PyPI and Anaconda.org. Install the package with one of two commands.
$ pip install pytask
or
$ conda install -c conda-forge pytask
Verify the installation by displaying the help page listing all available commands and some options.
$ pytask --help
<center>pytask v0.4.0</center>
Usage: <b>pytask [OPTIONS] [COMMAND] [PATHS]</b>
Manage your tasks with pytask.
<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> <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> This is pytask's default command. pytask collects tasks from the <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> given paths or the current working directory, executes them <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> and reports 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 project's 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 tasks like runtime and memory consumption <font color="#5f5f5f">│</font>
<font color="#5f5f5f">│</font> of products. <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>
To see command-specific help pages, type
$ pytask <command-name> --help
Color support is automatically available on non-Windows platforms. On Windows, please, use Windows Terminal, which can be installed via the Microsoft Store.