l9format python

l9format is a schema declaration targeted at interoperability between network recon tools used at LeakIX.

This library is equivalent to l9format which provides a Go implementation.

Tools and Usage

Running Tests

We use pytest for testing. Run the tests with:

poetry run pytest

Code Formatting

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

poetry run black .

Import Sorting

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

poetry run isort .

Code Linting

We use ruff for linting. Run:

poetry run ruff check .

Install

See releases for the different versions. The release 1.3.1-0 will be mapped to 1.3.1.post0.

Documentation

from l9format import l9format
l9format.L9Event.from_dict(res)

Versioning

The versions will be synced with l9format, suffixed by a number for bug fixes in the python implementation specifically. For instance, 1.3.1-0 will be the first version for 1.3.1 and follow https://github.com/LeakIX/l9format/releases/tag/v1.3.1. If a change is required for the Python package, but is the same specification than the Go implementation, the next release will be 1.3.1-1. The version can be verified using

import l9format
l9format.__version__