Skip to content

Commit 17e6a34

Browse files
authored
chore: update install docs and typing setup (#742)
1 parent 9894805 commit 17e6a34

13 files changed

Lines changed: 51 additions & 144 deletions

.github/dependabot.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,11 @@ updates:
55
directory: "/"
66
schedule:
77
interval: "weekly"
8-
98
groups:
109
github-actions:
1110
patterns:
1211
- "*"
12+
- package-ecosystem: "uv"
13+
directory: "/"
14+
schedule:
15+
interval: "weekly"

.python-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.14
1+
3.13

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,6 @@ or
6262
$ pixi add pytask
6363
```
6464

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

docs/source/developers_guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,11 @@ $ python -m cProfile -o log.pstats -m pytask directory/with/tasks
5252
The profile can be visualized with
5353

5454
```console
55-
$ pip install yelp-gprof2dot
55+
$ uv add yelp-gprof2dot
56+
57+
# or
58+
59+
$ pixi add --pypi yelp-gprof2dot
5660
$ gprof2dot log.pstats | dot -T svg -o out.svg
5761
```
5862

docs/source/how_to_guides/hashing_inputs_of_tasks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ function to the {class}`~pytask.PythonNode` that generates a stable hash.
5454
First, install `deepdiff`.
5555

5656
```console
57-
$ pip install deepdiff
58-
$ conda install deepdiff
57+
$ uv add deepdiff
58+
$ pixi add deepdiff
5959
```
6060

6161
Then, create the hash function and pass it to the node. Make sure it returns either an

docs/source/how_to_guides/migrating_from_scripts_to_pytask.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ guide concludes with an additional example of an R script.
2121

2222
## Installation
2323

24-
To get started with pytask, simply install it with pip or conda:
24+
To get started with pytask, install it with uv or pixi:
2525

2626
```console
27-
$ pip install pytask pytask-parallel
27+
$ uv add pytask pytask-parallel
2828

29-
$ conda -c conda-forge pytask pytask-parallel
29+
$ pixi add pytask pytask-parallel
3030
```
3131

3232
## From Python script to task
@@ -104,9 +104,9 @@ about the plugin in the repo's readme.
104104
First, we will install the package.
105105

106106
```console
107-
$ pip install pytask-r
107+
$ uv add pytask-r
108108

109-
$ conda install -c conda-forge pytask-r
109+
$ pixi add pytask-r
110110
```
111111

112112
```{seealso}

docs/source/tutorials/installation.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,6 @@ $ pixi add pytask
2222

2323
Learn more about [uv](https://docs.astral.sh/uv/) and [pixi](https://pixi.sh/).
2424

25-
## Traditional
26-
27-
You can also install pytask using traditional package managers:
28-
29-
```console
30-
$ pip install pytask
31-
```
32-
33-
or
34-
35-
```console
36-
$ conda install -c conda-forge pytask
37-
```
38-
3925
<!-- END: Keep in sync with README.md -->
4026

4127
Verify the installation by displaying the help page listing all available commands and

docs/source/tutorials/set_up_a_project.md

Lines changed: 0 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -128,68 +128,7 @@ paths = ["src/my_project"]
128128
129129
````
130130
131-
````{tab-item} pip
132-
:sync: pip
133131
134-
Create a `pyproject.toml` file for project configuration:
135-
136-
```toml
137-
[project]
138-
name = "my_project"
139-
version = "0.1.0"
140-
requires-python = ">=3.10"
141-
dependencies = ["pytask"]
142-
143-
[build-system]
144-
requires = ["hatchling"]
145-
build-backend = "hatchling.build"
146-
147-
[tool.pytask.ini_options]
148-
paths = ["src/my_project"]
149-
```
150-
151-
Also create a `requirements.txt` file:
152-
153-
```text
154-
pytask
155-
```
156-
157-
````
158-
159-
````{tab-item} conda/mamba
160-
:sync: conda
161-
162-
Create an `environment.yml` file that includes the editable install:
163-
164-
```yaml
165-
name: my_project
166-
channels:
167-
- conda-forge
168-
dependencies:
169-
- python>=3.10
170-
- pytask
171-
- pip
172-
- pip:
173-
- -e .
174-
```
175-
176-
And a `pyproject.toml` file for project configuration:
177-
178-
```toml
179-
[project]
180-
name = "my_project"
181-
version = "0.1.0"
182-
requires-python = ">=3.10"
183-
184-
[build-system]
185-
requires = ["hatchling"]
186-
build-backend = "hatchling"
187-
188-
[tool.pytask.ini_options]
189-
paths = ["src/my_project"]
190-
```
191-
192-
````
193132
`````
194133

195134
The `[tool.pytask.ini_options]` section tells pytask to look for tasks in
@@ -227,33 +166,4 @@ pixi automatically creates the environment and installs dependencies. pixi will
227166
228167
````
229168
230-
````{tab-item} pip
231-
:sync: pip
232-
233-
```console
234-
$ pip install -e .
235-
```
236-
237-
This creates an editable install where changes in the package's source files are immediately available in the installed version.
238-
239-
````
240-
241-
````{tab-item} conda/mamba
242-
:sync: conda
243-
244-
```console
245-
$ conda env create -f environment.yml
246-
$ conda activate my_project
247-
```
248-
249-
Or with mamba:
250-
251-
```console
252-
$ mamba env create -f environment.yml
253-
$ mamba activate my_project
254-
```
255-
256-
The editable install is automatically handled by the `pip: -e .` entry in `environment.yml`.
257-
258-
````
259169
`````

docs/source/tutorials/visualizing_the_dag.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
To visualize the {term}`DAG` of the project, first, install
44
[pygraphviz](https://github.com/pygraphviz/pygraphviz) and
5-
[graphviz](https://graphviz.org/). For example, you can both install with conda
5+
[graphviz](https://graphviz.org/). For example, you can both install with pixi
66

77
```console
8-
$ conda install -c conda-forge pygraphviz
8+
$ pixi add pygraphviz graphviz
99
```
1010

1111
After that, pytask offers two interfaces to visualize your project's {term}`DAG`.

justfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ test-cov *FLAGS:
1212

1313
# Run type checking
1414
typing:
15-
uv run --group typing --group test ty check src/ tests/
15+
uv run --group typing --group test --isolated ty check src/ tests/
1616

1717
# Run linting
1818
lint:

0 commit comments

Comments
 (0)