1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
|
# Management commands
The entry-point to run commands to manage the project is our Python `make` script, located in the `scripts` folder. You can either call it directly with `./scripts/make`, or you can use [direnv](https://direnv.net/) to add the script to your command line path. Once direnv is installed and hooked into your shell, allow it once for this directory with `direnv allow`. Now you can directly call the Python script with `make`. The `Makefile` is just here to provide auto-completion.
Try typing `make` or `make help` to show the available commands.
```console exec="1" source="console"
$ alias make="$PWD/scripts/make"; cd # markdown-exec: hide
$ make
```
## Commands
Commands are always available: they don't require any Python dependency to be installed.
[](){#command-setup}
### `setup`
::: make.setup
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-help}
### `help`
::: make.help
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-run}
### `run`
::: make.run
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-multirun}
### `multirun`
::: make.multirun
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-allrun}
### `allrun`
::: make.allrun
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-3.x}
### `3.x`
::: make.run3x
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-clean}
### `clean`
::: make.clean
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#command-vscode}
### `vscode`
::: make.vscode
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
## Tasks
Tasks require the Python dependencies to be installed. They use various tools and libraries to assert code quality, run tests, serve the documentation locally, or build and publish distributions of your project. There are multiple ways to run tasks:
- `make TASK`, the main, configured way to run a task
- `make run duty TASK`, to run a task in the default environment
- `make multirun duty TASK`, to run a task on all supported Python versions
- `make allrun duty TASK`, to run a task in *all* environments
- `make 3.x duty TASK`, to run a task on a specific Python version
[](){#task-build}
### `build`
::: duties.build
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-changelog}
### `changelog`
::: duties.changelog
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-check}
### `check`
::: duties.check
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-check-api}
### `check-api`
::: duties.check_api
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-check-docs}
### `check-docs`
::: duties.check_docs
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-check-quality}
### `check-quality`
::: duties.check_quality
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-check-types}
### `check-types`
::: duties.check_types
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-coverage}
### `coverage`
::: duties.coverage
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-docs}
### `docs`
::: duties.docs
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-docs-deploy}
### `docs-deploy`
::: duties.docs_deploy
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-format}
### `format`
::: duties.format
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-fuzz}
### `fuzz`
::: duties.fuzz
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-publish}
### `publish`
::: duties.publish
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-release}
### `release`
::: duties.release
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
[](){#task-test}
### `test`
::: duties.test
options:
heading_level: 3
show_root_heading: false
show_root_toc_entry: false
separate_signature: false
parameter_headings: false
|
