Metadata-Version: 2.4
Name: nigerian-states
Version: 0.1.2
Summary: A Python package for Nigerian states and LGAs.
Home-page: https://github.com/doubi3/nigerian-states
Author: Mark Ekperi
Author-email: mark.ekperi@gmail.com
License: MIT
Project-URL: Bug Tracker, https://github.com/doubi3/nigerian-states/issues
Project-URL: Source, https://github.com/doubi3/nigerian-states
Keywords: nigeria,states,lga,local-government-areas,geodata
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-python
Dynamic: summary

# Nigerian States and LGAs

A Python package for accessing Nigerian states and their respective Local Government Areas (LGAs).

## Features
- List all Nigerian states
- Get LGAs for a given state (case-insensitive)
- Search LGAs by name (case-insensitive)

## Installation

Install from PyPI (when available):
```bash
pip install nigerian-states
```

Or install from source:
```bash
git clone https://github.com/doubi3/nigerian-states.git
cd nigerian-states
pip install .
```

## Usage

```python
from nigerian_states.states.core import NigerianStates

ng = NigerianStates()

# List all states
states = ng.get_states()
print(states)

# Get LGAs for a state
lagos_lgas = ng.get_lgas('Lagos')
print(lagos_lgas)

# Search for LGAs containing a substring
search_results = ng.search_lga('Ikeja')
print(search_results)
```

## API Reference

### class NigerianStates

#### get_states()
> Returns a list of all Nigerian state names.

#### get_lgas(state)
> Returns a list of LGAs for the given state (case-insensitive). Returns an empty list if the state is not found.

#### search_lga(query)
> Returns a list of LGAs whose names contain the query substring (case-insensitive).

## Contributing

Contributions, bug reports, and feature requests are welcome! Please open an issue or submit a pull request on GitHub.

## Releasing

To publish a new version, update the version in `setup.py`, push the change, and create a published GitHub Release. The publish workflow will build the package and upload it to PyPI using trusted publishing.

Applications do not update automatically. Users must upgrade with:

```bash
pip install --upgrade nigerian-states
```

## License

MIT License. See [LICENSE](LICENSE) for details.

## Author

Mark Ekperi

For questions or suggestions, please contact [Mark Ekperi](mailto:mark.ekperi@gmail.com).
