Skip to content

Commit da0bc69

Browse files
authored
Merge pull request #29 from bk86a/docs/readme-v013
docs: update README for v0.13.0
2 parents 1c9163a + b953eb6 commit da0bc69

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -548,13 +548,35 @@ app/
548548
├── models.py # Pydantic response models
549549
├── postal_patterns.py # Pattern loading, preprocessing + extract_postal_code()
550550
└── postal_patterns.json # Per-country regex patterns, examples, expected_digits
551+
tests/
552+
├── conftest.py # Shared fixtures with mock TERCET data
553+
├── test_postal_patterns.py
554+
├── test_data_loader.py
555+
└── test_api.py
551556
scripts/
552557
└── import_estimates.py # CLI: import pre-computed estimates into SQLite DB
553558
tercet_missing_codes.csv # Pre-computed NUTS estimates for codes missing from TERCET
559+
Makefile # Standard targets: lint, format, test, run, docker-build
554560
```
555561
556562
Postal patterns and confidence settings are stored in JSON files (`postal_patterns.json`, `settings.json`) for easy editing without touching Python code. The `countries` list can still be overridden via the `PC2NUTS_COUNTRIES` environment variable.
557563
564+
## Development
565+
566+
```bash
567+
pip install -r requirements-dev.txt # runtime + dev/test dependencies
568+
make test # run pytest suite
569+
make lint # ruff check
570+
make format # ruff format (auto-fix)
571+
```
572+
573+
Pre-commit hooks are available via [pre-commit](https://pre-commit.com/):
574+
575+
```bash
576+
pip install pre-commit
577+
pre-commit install
578+
```
579+
558580
## Adding a new country
559581

560582
If GISCO publishes TERCET data for a new country, the service discovers and loads it automatically on restart — no code changes needed. Lookups work immediately via the fallback normalizer.

0 commit comments

Comments
 (0)