Metadata-Version: 2.4
Name: refdatakit
Version: 0.1.0
Summary: Source-aware reference data and validation tools
Author: RefDataKit contributors
License: MIT
Project-URL: Homepage, https://github.com/rezwan4029/refdatakit#readme
Project-URL: Documentation, https://github.com/rezwan4029/refdatakit/blob/main/packages/python/README.md
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema<5,>=4.23
Requires-Dist: rfc8785<0.2,>=0.1.4
Provides-Extra: dev
Requires-Dist: pytest>=8.3; extra == "dev"
Requires-Dist: ruff>=0.11; extra == "dev"
Dynamic: license-file

# refdatakit

Source-aware regional reference data and validation tools for Python.

Documentation: [Python package guide](https://github.com/rezwan4029/refdatakit/blob/main/packages/python/README.md) · [Project overview](https://github.com/rezwan4029/refdatakit#readme) · [JavaScript/TypeScript package guide](https://github.com/rezwan4029/refdatakit/blob/main/packages/js/README.md).

Install from PyPI with `pip install refdatakit`. The package includes the versioned JSON datasets. Data access is local and makes no network requests.

```python
from refdatakit import CountryCode, get_cities, get_country, get_institutions

country = get_country(CountryCode.BD)
cities = get_cities(CountryCode.BD)
institutions = get_institutions(CountryCode.BD)
```

Available accessors are `get_countries()`, `get_country(code)`, `get_cities(code)`, `get_subdivisions(code)`, and `get_institutions(code)`. Country arguments require a generated `CountryCode` enum member; passing a raw string raises `TypeError`. They return dictionaries/lists matching the shared JSON schemas. Source provenance and dataset licenses are recorded in the bundled manifest; dataset terms may differ from the MIT-licensed SDK code.

The `refdatakit validate` and `refdatakit sort` commands are repository maintenance tools. The Python package exposes `validate_repository(path)` and `sort_repository(path)` for contributor workflows.
