Skip to content

Commit 18c310d

Browse files
tobiasraabetobiasraabe
authored
Improve installation instructions and fix terminal animations (#686)
1 parent 7c3b3d9 commit 18c310d

35 files changed

+584
-280
lines changed

‎README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,20 @@ features include:
5050
<!-- Keep in sync with docs/source/tutorials/installation.md -->
5151

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

5555
```console
56-
$ pip install pytask
56+
$ uv add pytask
5757
```
5858

5959
or
6060

6161
```console
62-
$ conda install -c conda-forge pytask
62+
$ pixi add pytask
6363
```
6464

65+
or use pip, conda, or mamba if you like.
66+
6567
Color support is automatically available on non-Windows platforms. On Windows, please,
6668
use [Windows Terminal](https://github.com/microsoft/terminal), which can be, for
6769
example, installed via the [Microsoft Store](https://aka.ms/terminal).

‎docs/Makefile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,6 @@ help:
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
2020
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21+
22+
livehtml:
23+
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/source/_static/md/capture.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
```console
44

55
$ pytask
6-
──────────────────────────── Start pytask session ────────────────────────────
7-
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>
6+
────────────────────────── Start pytask session ─────────────────────────
7+
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>
88
Root: C:\Users\pytask-dev\git\my_project
99
Collected <span style="color: var(--termynal-blue)">2</span> tasks.
1010

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

18-
<span style="color: #bf2d2d">────────────────────────────────── Failures ──────────────────────────────────</span>
19-
20-
<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>
21-
22-
<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>
23-
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
24-
<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>
25-
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
26-
<span style="color: #cd3131">│</span> 10 <span style="color: #cd3131">│</span>
27-
<span style="color: #cd3131">│</span> 11 <span style="color: #3b8eea">def</span> <span style="color: #23d18b">task_func2</span>(): <span style="color: #cd3131">│</span>
28-
<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>
29-
<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>
30-
<span style="color: #cd3131">│</span> 14 <span style="color: #cd3131">│</span>
31-
<span style="color: #cd3131">│</span> 15 <span style="color: #cd3131">│</span>
32-
<span style="color: #cd3131">╰────────────────────────────────────────────────────────────────────────────╯</span>
18+
<span style="color: #bf2d2d">──────────────────────────────── Failures ───────────────────────────────</span>
19+
20+
<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>
21+
22+
<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>
23+
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
24+
<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>
25+
<span style="color: #cd3131">│</span> <span style="color: #cd3131">│</span>
26+
<span style="color: #cd3131">│</span> 10 <span style="color: #cd3131">│</span>
27+
<span style="color: #cd3131">│</span> 11 <span style="color: #3b8eea">def</span> <span style="color: #23d18b">task_func2</span>(): <span style="color: #cd3131">│</span>
28+
<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>
29+
<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>
30+
<span style="color: #cd3131">│</span> 14 <span style="color: #cd3131">│</span>
31+
<span style="color: #cd3131">│</span> 15 <span style="color: #cd3131">│</span>
32+
<span style="color: #cd3131">╰───────────────────────────────────────────────────────────────────────╯</span>
3333
<span style="color: #f14c4c; font-weight: bold;">AssertionError</span>
3434

35-
──────────────────────── Captured stdout during call ─────────────────────────
35+
────────────────────── Captured stdout during call ──────────────────────
3636
Debug Statement
3737

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

4747
</div>

‎docs/source/_static/md/clean-dry-run-directories.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
```console
44

55
$ pytask clean --directories
6-
──────────────────────────── Start pytask session ────────────────────────────
7-
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>
6+
────────────────────────── Start pytask session ─────────────────────────
7+
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>
88
Root: C:\Users\pytask-dev\git\my_project
99
Collected <span style="color: var(--termynal-blue)">1</span> task.
1010

1111
Files which can be removed:
1212

1313
Would remove svgs/obsolete_file_1.md
1414
Would remove svgs/obsolete_folder
15-
──────────────────────────────────────────────────────────────────────────────
15+
─────────────────────────────────────────────────────────────────────────
1616
```
1717

1818
</div>

‎docs/source/_static/md/clean-dry-run.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
```console
44

55
$ pytask clean
6-
──────────────────────────── Start pytask session ────────────────────────────
7-
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>
6+
────────────────────────── Start pytask session ─────────────────────────
7+
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>
88
Root: C:\Users\pytask-dev\git\my_project
99
Collected <span style="color: var(--termynal-blue)">1</span> task.
1010

@@ -13,7 +13,7 @@ Files which can be removed:
1313
Would remove svgs/obsolete_file_1.md
1414
Would remove svgs/obsolete_folder/obsolete_file_2.md
1515
Would remove svgs/obsolete_folder/obsolete_file_3.md
16-
──────────────────────────────────────────────────────────────────────────────
16+
─────────────────────────────────────────────────────────────────────────
1717
```
1818

1919
</div>

‎docs/source/_static/md/collect-nodes.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
```console
44

55
$ pytask
6-
──────────────────────────── Start pytask session ────────────────────────────
7-
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>
6+
────────────────────────── Start pytask session ─────────────────────────
7+
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>
88
Root: C:\Users\pytask-dev\git\my_project
99
Collected <span style="color: var(--termynal-blue)">1</span> task.
1010

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

17-
──────────────────────────────────────────────────────────────────────────────
17+
─────────────────────────────────────────────────────────────────────────
1818
```
1919

2020
</div>

‎docs/source/_static/md/collect.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
```console
44

55
$ pytask
6-
──────────────────────────── Start pytask session ────────────────────────────
7-
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>
6+
────────────────────────── Start pytask session ─────────────────────────
7+
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>
88
Root: C:\Users\pytask-dev\git\my_project
99
Collected <span style="color: var(--termynal-blue)">1</span> task.
1010

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

15-
──────────────────────────────────────────────────────────────────────────────
15+
─────────────────────────────────────────────────────────────────────────
1616
```
1717

1818
</div>

‎docs/source/_static/md/defining-dependencies-products.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
```console
44

55
$ pytask
6-
──────────────────────────── Start pytask session ────────────────────────────
7-
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>
6+
────────────────────────── Start pytask session ─────────────────────────
7+
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>
88
Root: C:\Users\pytask-dev\git\my_project
99
Collected <span style="color: var(--termynal-blue)">2</span> task.
1010

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

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

2626
</div>

0 commit comments

Comments
 (0)