aetechlabs/nigeria-states-lgas-py
Record type:
software
Creator:
aet
Host:
A Python package containing all 36 Nigerian States + FCT and their Local Government Areas (LGAs).
# Nigeria States & LGAs (Python Package)
A simple Python package containing all **36 Nigerian States + FCT** and their **Local Government Areas (LGAs)**.
## Installation
```bash
pip install nigeria-states-lgas
```
## Usage
```python
from nigeria_states_lgas import get_states, get_lgas, get_all, search_lga
# List all states
print(get_states())
# Get LGAs for a specific state
print(get_lgas("Kano"))
# Search which state(s) an LGA belongs to
print(search_lga("Ikot Ekpene"))
# Get the full dataset
all_data = get_all()
print(all_data["Lagos"])
```
## CLI Usage
After installing the package a CLI `nigeria-states-lgas` is available:
```bash
# List all states
nigeria-states-lgas states
# List LGAs for a state
nigeria-states-lgas lgas Lagos
# Fuzzy search for an LGA
nigeria-states-lgas search-lga "Dala" --fuzzy
# Fuzzy search for states
nigeria-states-lgas search-states "Plateu" --fuzzy
```
## Features
- Provides all 36 Nigerian States + FCT.
- Lists all Local Government Areas (LGAs) for each state.
- Search for any LGA to find which state(s) it belongs to.
- Easy integration into Python projects.
## Contributing
Contributions are welcome! Please feel free to fork the repo and submit pull requests.
## License
This project is licensed under the MIT License. See LICENSE for details.