This repository has been archived by the owner on Dec 5, 2022. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Taskfile.yml
68 lines (60 loc) · 1.67 KB
/
Taskfile.yml
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
version: "3"
tasks:
default:
desc: A bunch of default task to run when the state of the development is satisfactory.
summary: |
A bunch of default tasks to run when the state of the development is satisfactory.
cmds:
- task: lint
- task: test
cleanup:
desc: Perform some default cleanup tasks.
summary: |
Perform some cleaning up tasks after the development like deactivating virtual environments & what not.
cmds:
- exit
docs:build:
desc: Build the Sphinx documentations.
summary: |
Build the documentations using Sphinx.
dir: docs
sources:
- docs/**/*.rst
generates:
- docs/build/*
cmds:
- sphinx-build -b html source build
docs:preview:
desc: Preview the documentations in the browser.
summary: |
Preview the documentations in a local session of the browser.
P.S. Don't forget to use the "--watch" flag to watch for updates in the documentation sources.
deps:
- docs:build
dir: docs
cmds:
- xdg-open build/index.html
deps:install:
desc: Install the development dependencies for the project.
summary: |
Install the development dependencies for the project.
run: once
cmds:
- poetry install
- poetry export --dev --output requirements.txt
lint:
desc: Run a bunch of linters & formatter to maintain code cleanliness.
summary: |
Run a bunch of linters & formatters to maintain code cleanliness & standards.
cmds:
- pylint .
- black .
- isort .
test:
desc: Run the test suite.
summary: |
Run the test suite.
deps:
- lint
cmds:
- pytest .