Skip to content

Commit fa970ea

Browse files
committed
added docs
1 parent 64a6687 commit fa970ea

File tree

3 files changed

+42
-18
lines changed

3 files changed

+42
-18
lines changed

README.md

+3-18
Original file line numberDiff line numberDiff line change
@@ -107,21 +107,6 @@ alembic upgrade head
107107

108108
* [postman collection documentation](https://documenter.getpostman.com/view/9920489/2sAYQZGBNJ)
109109

110-
## Linting and formatting
111-
112-
### with script
113-
114-
```bash
115-
./scripts/lint.sh
116-
./scripts/format.sh
117-
```
118-
119-
120-
### with pre-commit
121-
122-
```bash
123-
pre-commit install
124-
```
125-
126-
> [!NOTE]
127-
> pre-commit will run automatically when you commit your changes.
110+
## docs
111+
* [linting and formatting](_docs/lint-formatting.md)
112+
* [testing](_docs/testing.md)

_docs/lint-formatting.md

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Linting and formatting
2+
3+
## with script
4+
5+
```bash
6+
./scripts/lint.sh
7+
./scripts/format.sh
8+
```
9+
10+
11+
## with pre-commit
12+
13+
```bash
14+
pre-commit install
15+
```
16+
17+
> [!NOTE]
18+
> pre-commit will run automatically when you commit your changes.

_docs/testing.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Testing
2+
This project uses `pytest` and `pytest-asyncio` for testing, along with `unittest` for unit testing (particularly for mocking and patching).
3+
4+
# Run tests
5+
6+
Tests can be run using the test script:
7+
8+
```bash
9+
./scripts/test.sh
10+
```
11+
12+
The script runs pytest with the following features:
13+
- Code coverage reporting (minimum 80% coverage required)
14+
- Coverage reports in terminal, HTML, and XML formats
15+
- Verbose output
16+
17+
You can pass additional pytest arguments to the script:
18+
19+
```bash
20+
./scripts/test.sh -s
21+
```

0 commit comments

Comments
 (0)