Metadata-Version: 2.4
Name: niafaker
Version: 1.0.0
Summary: Fake data generator localized for African regions — names, phones, addresses, mobile money, national IDs, and more.
Author-email: Owden Godson <consultancy@owden.site>
License: MIT
Project-URL: Homepage, https://github.com/owgee/niafaker
Project-URL: Repository, https://github.com/owgee/niafaker
Project-URL: Issues, https://github.com/owgee/niafaker/issues
Keywords: faker,africa,test-data,mock,localization,mobile-money
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# NiaFaker

[![Tests](https://github.com/owgee/niafaker/actions/workflows/test.yml/badge.svg)](https://github.com/owgee/niafaker/actions/workflows/test.yml)
[![PyPI version](https://img.shields.io/pypi/v/niafaker.svg)](https://pypi.org/project/niafaker/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Fake data generator localized for African regions. Names, phone numbers, mobile money, national IDs, and more — culturally accurate for 10 African economies.

## Install

```bash
pip install niafaker
```

## Usage

```python
from niafaker import NiaFaker

fake = NiaFaker("tz")  # Tanzania

fake.name()            # "Baraka Kimaro"
fake.name(gender="f")  # "Amina Mwakasege"
fake.phone()           # "+255754832109"
fake.mobile_money()    # {"provider": "M-Pesa", "number": "+255754832109"}
fake.national_id()     # "19901234-12345-00001-01"
fake.company()         # "Bakhresa Holdings"
fake.amount()          # "TSh 425,000"
fake.address()         # "1234 Samora Avenue, Dodoma, Dodoma"
```

For reproducible output (useful in tests):

```python
fake = NiaFaker("ke", seed=42)
fake.name()  # same result every time
```

## Supported Countries

`tz` Tanzania · `ke` Kenya · `ng` Nigeria · `za` South Africa · `gh` Ghana · `ug` Uganda · `rw` Rwanda · `et` Ethiopia · `eg` Egypt · `ma` Morocco

```python
NiaFaker.locales()  # {'tz': 'Tanzania', 'ke': 'Kenya', ...}
```

## What You Can Generate

**Person** — `name()`, `first_name()`, `last_name()`, `email()`
**Phone** — `phone()`, `phone(carrier="Safaricom")`
**Address** — `city()`, `region()`, `address()`, `country()`
**Company** — `company()`, `registration_number()`
**Mobile Money** — `mobile_money()`, `transaction_id()`
**National ID** — `national_id()`
**Currency** — `amount()`

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md). Adding a new country is just 7 JSON files and one line in the config.

## License

MIT — [Owden Godson](https://owden.site)
