Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (38 loc) · 731 Bytes

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 731 Bytes

Contributing

Requirements

  • Python 3.8+
  • pip

Setup

python3 -m venv .venv
source .venv/bin/activate
pip install -e .[dev]

Run Tests

pytest

Coverage Check

pytest --cov=src/ipgeolocation --cov-report=term-missing --cov-fail-under=90

Static Checks

ruff check src tests
mypy src
pyright

Live Tests

Live tests are disabled by default and consume API credits.

IPGEO_RUN_LIVE_TESTS=true \
IPGEO_FREE_KEY=your_free_key \
IPGEO_PAID_KEY=your_paid_key \
pytest tests/test_live_integration.py

Optional live field-parity hardening:

IPGEO_RUN_LIVE_HARDENING=true \
IPGEO_PAID_KEY=your_paid_key \
pytest tests/test_live_field_parity.py