Developer Guide¶

Setup¶

Clone the repository and install the development dependencies.

git clone https://github.com/peppedilillo/gcn-notice-parser.git
cd gcn-notice-parser
uv sync --group dev

Install the hooks before committing.

uv run pre-commit install

The hooks run black, isort, and basic file checks.

Run the test suite from the project directory.

uv run pytest -q

Fixture collection reads messages from GCN Kafka and writes notice payloads under tests/fixtures.

cp .secrets.sample .secrets
vim .secrets
source .secrets
uv run tests/fixtures/collect_fixtures.py --help

The .secrets file must define the environment variables GCN_CLIENT_ID and GCN_CLIENT_SECRET.

Serve the documentation locally.

uv run mkdocs serve

Deploy the documentation to GitHub Pages.

uv run mkdocs gh-deploy