Skip to content

Commit 39fbfcd

Browse files
authored
Merge pull request #9 from LeakIX/dw/update-readme
Update README
2 parents 046073e + 269c004 commit 39fbfcd

1 file changed

Lines changed: 29 additions & 3 deletions

File tree

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,38 @@ recon tools used at LeakIX.
77
This library is equivalent to [l9format](https://github.com/leakix/l9format)
88
which provides a Go implementation.
99

10-
## Run the tests
10+
## Tools and Usage
1111

12+
### Running Tests
1213

14+
We use `pytest` for testing. Run the tests with:
15+
16+
```bash
17+
poetry run pytest
18+
```
19+
20+
### Code Formatting
21+
22+
We use `black` for code formatting. To format the code, run:
23+
24+
```bash
25+
poetry run black .
26+
```
27+
28+
### Import Sorting
29+
30+
We use `isort` to sort imports. To sort imports, run:
31+
32+
```bash
33+
poetry run isort .
1334
```
14-
poetry install
15-
poetry run pytest l9format/tests/test_l9format.py
35+
36+
### Code Linting
37+
38+
We use `ruff` for linting. Run:
39+
40+
```bash
41+
poetry run ruff check .
1642
```
1743

1844
## Install

0 commit comments

Comments
 (0)