Fakernaija

Fakernaija is a Python library that helps developers generate Nigerian-specific data like names, emails, addresses, phone numbers, banks, jobs, schools, states, license plate numbers, and much more. Whether you're working on testing, development, or educational projects, Fakernaija helps you generate realistic data, including a CLI for easy exports.

The documentation is available on Read the Docs.

---

 _____           _                                    _     _
|  ___|   __ _  | | __   ___   _ __   _ __     __ _  (_)   (_)   __ _
| |_     / _` | | |/ /  / _ \ | '__| | '_ \   / _` | | |   | |  / _` |
|  _|   | (_| | |   <  |  __/ | |    | | | | | (_| | | |   | | | (_| |
| |      \__,_| |_|\_\  \___| |_|    |_| |_|  \__,_| |_|  _/ |  \__,_|
|_|                                                      |__/

Features ✨

• Generate culturally accurate Nigerian data — no more Oyinbo data that don't gel!
• Quickly generate data from your favourite terminal with our CLI commands.
• Export your generated data to various formats like JSON, CSV, and plain text.

Installation 🛠️

Fakernaija requires Python 3.10 or higher. Installation is easy-peasy with pip, ensuring you get the latest stable release of the library.

pip install -U fakernaija

Quick Start 🚀

Fakernaija is easy to use. Launch your Python shell and try out the example below:

>>> from fakernaija import Faker
>>> naija = Faker()
>>> print("A random Nigerian full name:", naija.full_name())
A random Nigerian full name: Ihuoma Maduabuchi

For more available method calls, please refer to the Naija API Reference.

Command Line Usage 💻

Fakernaija's CLI allows you to generate data directly from your terminal. Launch your favourite terminal and try out the example below:

$ naija email --domain unn.edu.ng --gender female --repeat 3
ololade.lawal@unn.edu.ng
kudiratbello@unn.edu.ng
mmasichukwunwodo2000@unn.edu.ng

For more detailed usage of the CLI, please refer to the CLI API Reference.

What Next? ➡️

A more comprehensive documentation is available on Read the Docs 📚

If you would like to contribute, please read the Contributing Guide 🤝

If you found a bug or have any suggestions, please Raise an Issue 🐛

If you need to contact the author privately, please reach out on Twitter 🐦

If you find this library useful or worthy of your attention, please give it a Star ⭐

License 📜

Fakernaija is released under the MIT License.