Skip to content

Commit e5d4919

Browse files
committed
add Taskfile.yml
1 parent cfcb2e3 commit e5d4919

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

Taskfile.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
version: '3'
2+
3+
tasks:
4+
default:
5+
cmds:
6+
- task --list
7+
silent: true
8+
9+
install:
10+
desc: Install dependencies
11+
cmd: uv sync --dev
12+
13+
install-fastapi:
14+
desc: Install FastAPI
15+
cmd: uv pip install "fastapi[standard]"
16+
17+
ci:
18+
desc: Run tests that runs in CI
19+
cmds:
20+
- task: test
21+
- task: lint
22+
23+
test:
24+
desc: Run pytest
25+
cmd: uv run pytest tests/ --tb=short -ra --cov=src/sheppy --cov-report=term-missing
26+
27+
lint:
28+
desc: Run mypy and ruff check
29+
cmds:
30+
- uv run mypy --strict src/sheppy/
31+
- uv run ruff check src/ tests/
32+
33+
lintf:
34+
# desc: Run ruff format check (doesn't run in CI atm)
35+
cmd: uv run ruff format --check src/ tests/
36+
37+
generate_cli_docs:
38+
desc: Generates docs/cli.md
39+
cmd: uv run typer sheppy.cli.cli utils docs --name sheppy --title "Sheppy CLI reference" --output docs/reference/cli.md
40+
41+
py310:
42+
desc: Switch Python to version 3.10
43+
cmd: uv venv --python 3.10 --clear && uv sync --dev
44+
45+
py311:
46+
desc: Switch Python to version 3.11
47+
cmd: uv venv --python 3.11 --clear && uv sync --dev
48+
49+
py312:
50+
desc: Switch Python to version 3.12
51+
cmd: uv venv --python 3.12 --clear && uv sync --dev
52+
53+
py313:
54+
desc: Switch Python to version 3.13
55+
cmd: uv venv --python 3.13 --clear && uv sync --dev
56+
57+
py314:
58+
desc: Switch Python to version 3.14
59+
cmd: uv venv --python 3.14 --clear && uv sync --dev
60+
61+
docs-install:
62+
desc: Install dependencies for docs
63+
cmd: uv pip install mkdocs-material==9.6.20 'mkdocstrings[python]==0.30.1'
64+
65+
docs-build:
66+
desc: Build docs
67+
cmd: uv run mkdocs build
68+
69+
docs-dev:
70+
desc: Run docs locally
71+
cmd: uv run mkdocs serve --livereload -w src -w examples # --strict

0 commit comments

Comments
 (0)