We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent dcfc22e commit 9e8ca47Copy full SHA for 9e8ca47
README.md
@@ -7,3 +7,29 @@ This repository provides a template for Python 3.12 projects based on [Poetry](h
7
* [mypy](https://mypy.readthedocs.io/en/stable) is used for type checking
8
* [pytest](https://docs.pytest.org/en/8.2.x) is used for writing tests
9
* [ruff](https://docs.astral.sh/ruff) is used for linting and formatting
10
+
11
+## Usage
12
13
+To setup the virtual environment and install your project, run:
14
15
+```shell
16
+make install
17
+```
18
19
+To use the linter and type checker, run:
20
21
22
+make lint
23
24
25
+To run the test suite:
26
27
28
+make test
29
30
31
+To lint, type check, and test in a single command, run:
32
33
34
+make check
35
0 commit comments