Skip to content

Improve installation instructions and fix terminal animations #686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tobiasraabe merged 4 commits into from
Jun 8, 2025
Merged

Improve installation instructions and fix terminal animations #686

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6b6cc59
Update installation instructions and wording.
tobiasraabe Jun 7, 2025
5f4f26e
Update project setup with different package managers.
tobiasraabe Jun 8, 2025
fddb9d8
Correct version numbers in examples.
tobiasraabe Jun 8, 2025
91bd397
Fix terminal animations.
tobiasraabe Jun 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,18 +50,20 @@ features include:
<!-- Keep in sync with docs/source/tutorials/installation.md -->

pytask is available on [PyPI](https://pypi.org/project/pytask) and on
[Anaconda.org](https://anaconda.org/conda-forge/pytask). Install the package with
[conda-forge](https://anaconda.org/conda-forge/pytask). Install the package with

```console
$ pip install pytask
$ uv add pytask
```

or

```console
$ conda install -c conda-forge pytask
$ pixi add pytask
```

or use pip, conda, or mamba if you like.

Color support is automatically available on non-Windows platforms. On Windows, please,
use [Windows Terminal](https://github.com/microsoft/terminal), which can be, for
example, installed via the [Microsoft Store](https://aka.ms/terminal).
Expand Down
3 changes: 3 additions & 0 deletions docs/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@ help:
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

livehtml:
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
40 changes: 20 additions & 20 deletions docs/source/_static/md/capture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
```console

$ pytask
──────────────────────────── Start pytask session ────────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.10.0</span>, pytask <span style="color: var(--termynal-blue)">0.4.0</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
────────────────────────── Start pytask session ─────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.12.0</span>, pytask <span style="color: var(--termynal-blue)">0.5.3</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
Root: C:\Users\pytask-dev\git\my_project
Collected <span style="color: var(--termynal-blue)">2</span> tasks.

Expand All @@ -15,33 +15,33 @@ Collected <span style="color: var(--termynal-blue)">2</span> tasks.
│ <span class="termynal-dim">task_capture.py::</span>task_func2 │ <span class="termynal-failed">F </span> │
└──────────────────────────────┴─────────┘

<span style="color: #bf2d2d">────────────────────────────────── Failures ──────────────────────────────────</span>

<span style="color: #bf2d2d">─────────────────── Task </span><span style="color: #6c1e1e; font-weight: bold">task_capture.py::</span><span style="color: #bf2d2d">task_func2</span><span style="color: #bf2d2d"> failed ──────────────────</span>

<span style="color: #f14c4c">╭─────────────────────</span><span style="color: #f14c4c; font-weight: bold;"> Traceback </span><span style="color: #6c1e1e; font-weight: bold">(most recent call last)</span><span style="color: #f14c4c"> ────────────────────╮</span>
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> <span style="color: #e5e510">...\git\pytask-examples\task_capture.py</span>:<span style="color: #3b8eea">13</span> in <span style="color: #23d18b">task_func2</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 10 <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 11 <span style="color: #3b8eea">def</span> <span style="color: #23d18b">task_func2</span>(): <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 12 │ <span style="color: #29b8db">print</span>(<span style="color: #e5e510">&quot;Debug statement&quot;</span>) <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> <span style="color: #cd3131">❱ </span>13 <span style="font-size: .2em;">&thinsp;</span>│ <span style="color: #3b8eea">assert</span> <span style="color: #3b8eea">False</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 14 <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 15 <span style="color: #cd3131">│</span>
<span style="color: #cd3131">╰────────────────────────────────────────────────────────────────────────────╯</span>
<span style="color: #bf2d2d">──────────────────────────────── Failures ───────────────────────────────</span>

<span style="color: #bf2d2d">──────────────── Task </span><span style="color: #6c1e1e; font-weight: bold">task_capture.py::</span><span style="color: #bf2d2d">task_func2</span><span style="color: #bf2d2d"> failed ────────────────</span>

<span style="color: #f14c4c">╭───────────────────</span><span style="color: #f14c4c; font-weight: bold;"> Traceback </span><span style="color: #6c1e1e; font-weight: bold">(most recent call last)</span><span style="color: #f14c4c"> ─────────────────╮</span>
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> <span style="color: #e5e510">...\git\pytask-examples\task_capture.py</span>:<span style="color: #3b8eea">13</span> in <span style="color: #23d18b">task_func2</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 10 <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 11 <span style="color: #3b8eea">def</span> <span style="color: #23d18b">task_func2</span>(): <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 12 │ <span style="color: #29b8db">print</span>(<span style="color: #e5e510">&quot;Debug statement&quot;</span>) <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> <span style="color: #cd3131">❱ </span>13 │ <span style="color: #3b8eea">assert</span> <span style="color: #3b8eea">False</span> <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 14 <span style="color: #cd3131">│</span>
<span style="color: #cd3131">│</span> 15 <span style="color: #cd3131">│</span>
<span style="color: #cd3131">╰───────────────────────────────────────────────────────────────────────╯</span>
<span style="color: #f14c4c; font-weight: bold;">AssertionError</span>

──────────────────────── Captured stdout during call ─────────────────────────
────────────────────── Captured stdout during call ──────────────────────
Debug Statement

<span class="termynal-dim">──────────────────────────────────────────────────────────────────────────────</span>
<span class="termynal-dim">─────────────────────────────────────────────────────────────────────────</span>
<span style="color: #bf2d2d">╭─────────── </span><span style="font-weight: bold;">Summary</span><span style="color: #bf2d2d"> ───────────╮</span>
<span style="color: #bf2d2d">│</span> <span style="font-weight: bold"> 2 Collected tasks </span> <span style="color: #bf2d2d">│</span>
<span style="color: #bf2d2d">│</span> <span class="termynal-success-textonly"> 1 Succeeded (50.0%) </span> <span style="color: #bf2d2d">│</span>
<span style="color: #bf2d2d">│</span> <span class="termynal-failed-textonly"> 1 Failed (50.0%) </span> <span style="color: #bf2d2d">│</span>
<span style="color: #bf2d2d">╰───────────────────────────────╯</span>
<span style="color: #bf2d2d">─────────────────────────── Failed in 0.03 seconds ───────────────────────────</span>
<span style="color: #bf2d2d">───────────────────────── Failed in 0.03 seconds ────────────────────────</span>
```

</div>
6 changes: 3 additions & 3 deletions docs/source/_static/md/clean-dry-run-directories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
```console

$ pytask clean --directories
──────────────────────────── Start pytask session ────────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.10.0</span>, pytask <span style="color: var(--termynal-blue)">0.4.0</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
────────────────────────── Start pytask session ─────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.12.0</span>, pytask <span style="color: var(--termynal-blue)">0.5.3</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
Root: C:\Users\pytask-dev\git\my_project
Collected <span style="color: var(--termynal-blue)">1</span> task.

Files which can be removed:

Would remove svgs/obsolete_file_1.md
Would remove svgs/obsolete_folder
──────────────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────────
```

</div>
6 changes: 3 additions & 3 deletions docs/source/_static/md/clean-dry-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
```console

$ pytask clean
──────────────────────────── Start pytask session ────────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.10.0</span>, pytask <span style="color: var(--termynal-blue)">0.4.0</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
────────────────────────── Start pytask session ─────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.12.0</span>, pytask <span style="color: var(--termynal-blue)">0.5.3</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
Root: C:\Users\pytask-dev\git\my_project
Collected <span style="color: var(--termynal-blue)">1</span> task.

Expand All @@ -13,7 +13,7 @@ Files which can be removed:
Would remove svgs/obsolete_file_1.md
Would remove svgs/obsolete_folder/obsolete_file_2.md
Would remove svgs/obsolete_folder/obsolete_file_3.md
──────────────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────────
```

</div>
6 changes: 3 additions & 3 deletions docs/source/_static/md/collect-nodes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
```console

$ pytask
──────────────────────────── Start pytask session ────────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.10.0</span>, pytask <span style="color: var(--termynal-blue)">0.4.0</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
────────────────────────── Start pytask session ─────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.12.0</span>, pytask <span style="color: var(--termynal-blue)">0.5.3</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
Root: C:\Users\pytask-dev\git\my_project
Collected <span style="color: var(--termynal-blue)">1</span> task.

Expand All @@ -14,7 +14,7 @@ Collected tasks:
├── 📄 &lt;Dependency my_project/in.txt&gt;
└── 📄 &lt;Product my_project/out.txt&gt;

──────────────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────────
```

</div>
6 changes: 3 additions & 3 deletions docs/source/_static/md/collect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@
```console

$ pytask
──────────────────────────── Start pytask session ────────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.10.0</span>, pytask <span style="color: var(--termynal-blue)">0.4.0</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
────────────────────────── Start pytask session ─────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.12.0</span>, pytask <span style="color: var(--termynal-blue)">0.5.3</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
Root: C:\Users\pytask-dev\git\my_project
Collected <span style="color: var(--termynal-blue)">1</span> task.

Collected tasks:
└── 🐍 &lt;Module task_module.py&gt;
└── 📝 &lt;Function <span class="termynal-dim">task_module.py::</span>task_write_file&gt;

──────────────────────────────────────────────────────────────────────────────
─────────────────────────────────────────────────────────────────────────
```

</div>
8 changes: 4 additions & 4 deletions docs/source/_static/md/defining-dependencies-products.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
```console

$ pytask
──────────────────────────── Start pytask session ────────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.10.0</span>, pytask <span style="color: var(--termynal-blue)">0.4.0</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
────────────────────────── Start pytask session ─────────────────────────
Platform: win32 -- Python <span style="color: var(--termynal-blue)">3.12.0</span>, pytask <span style="color: var(--termynal-blue)">0.5.3</span>, pluggy <span style="color: var(--termynal-blue)">1.3.0</span>
Root: C:\Users\pytask-dev\git\my_project
Collected <span style="color: var(--termynal-blue)">2</span> task.

Expand All @@ -15,12 +15,12 @@ Collected <span style="color: var(--termynal-blue)">2</span> task.
│ <span class="termynal-dim">task_plot_data.py::</span>task_plot_data │ <span class="termynal-success">.</span> │
└───────────────────────────────────────────────────┴─────────┘

<span class="termynal-dim">──────────────────────────────────────────────────────────────────────────────</span>
<span class="termynal-dim">─────────────────────────────────────────────────────────────────────────</span>
<span class="termynal-success">╭───────────</span> <span style="font-weight: bold;">Summary</span> <span class="termynal-success">────────────╮</span>
<span class="termynal-success">│</span> <span style="font-weight: bold;"> 2 Collected tasks </span> <span class="termynal-success">│</span>
<span class="termynal-success">│</span> <span class="termynal-success-textonly"> 2 Succeeded (100.0%) </span> <span class="termynal-success">│</span>
<span class="termynal-success">╰────────────────────────────────╯</span>
<span class="termynal-success">───────────────────────── Succeeded in 0.06 seconds ──────────────────────────</span>
<span class="termynal-success">─────────────────────── Succeeded in 0.06 seconds ───────────────────────</span>
```

</div>
Loading