Reference

Reference hub for the barangay package: Python API, CLI, configuration, comparisons, data dictionary, and versioning.

Precise technical descriptions — exact signatures, parameters, return types, and field dictionaries. Use these when you need the details, not a tutorial.

Python API

Split into focused modules under Python API:

• Database — views, .get, .lookup, .search_fuzzy, .to_frame / .to_dicts, iteration, errors.
• Records — EnrichedRecord fields and hierarchy properties.
• Search — search_fuzzy(), SearchResult.
• Validation — validate() / validate_many(), ValidationResult.
• Versioning — use_version(), use_plugins(), Database, AdminLevel, module-level attributes.
• FuzzBase — create_fuzz_base(), FuzzBase (performance).
• Utilities — sanitization, date resolution, env config.
• Data models — pydantic AdminDiv family and DataManager.
• Legacy — deprecated search(), BARANGAY dicts, BarangayModel.

Other reference

• CLI reference
• Configuration
• Comparisons — barangay vs psgc-api vs raw PSA CSV.
• Data dictionary — every to_frame() / record field documented with provenance.

See also

• Concepts — the ideas behind the data
• How-To — task recipes