Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,38 @@ recon tools used at LeakIX.
This library is equivalent to [l9format](https://github.com/leakix/l9format)
which provides a Go implementation.

## Run the tests
## Tools and Usage

### Running Tests

We use `pytest` for testing. Run the tests with:

```bash
poetry run pytest
```

### Code Formatting

We use `black` for code formatting. To format the code, run:

```bash
poetry run black .
```

### Import Sorting

We use `isort` to sort imports. To sort imports, run:

```bash
poetry run isort .
```
poetry install
poetry run pytest l9format/tests/test_l9format.py

### Code Linting

We use `ruff` for linting. Run:

```bash
poetry run ruff check .
```

## Install
Expand Down