feat: nigerian license plate number generator [Issue #3]

Author: Pythonian

docs/source/changelog.rst

@@ -38,5 +38,5 @@ and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0
 
 **Added:**
 
-- Fakernaija data for: ``course``, ``degree``, ``email``, ``faculty``, ``marital_status``, ``name``, ``phonenumber``, ``religion``, ``school``, ``state``.
+- Fakernaija data for: ``course``, ``degree``, ``email``, ``faculty``, ``license_plate``, ``marital_status``, ``name``, ``phonenumber``, ``religion``, ``school``, ``state``.
 - Added everything else.

docs/source/commands.rst

@@ -88,6 +88,7 @@ Each category command is documented with practical examples. You can find a guid
    commands/degree
    commands/email
    commands/faculty
+   commands/license_plate
    commands/marital_status
    commands/name
    commands/phonenumber

docs/source/commands/license_plate.rst

@@ -0,0 +1,4 @@
+license_plate
+=============
+
+.. autofunction:: fakernaija.commands.license_plate

docs/source/index.rst

@@ -4,7 +4,7 @@ Welcome to Fakernaija's Documentation!
 Overview
 --------
 
-**Fakernaija** is a Python library that helps developers generate Nigerian-specific data like names, emails, addresses, phone numbers, bank details, school names, 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.
+**Fakernaija** is a Python library that can help developers generate Nigerian-specific data like names, emails, addresses, phone numbers, bank details, school names, states, license plate numbers, and much more. Whether you're working on testing, development, or educational projects, **Fakernaija** can help you to generate realistic data with Nigerian contexts, and it also comes with a CLI for easy data exports to various file formats.
 
 The source code is available on `GitHub <https://github.com/Pythonian/fakernaija>`_.
 
@@ -27,7 +27,7 @@ Features
 Installation
 ------------
 
-**Fakernaija** requires **Python 3.10** or higher. Installation is easy-peasy with `pip`, ensuring you always get the latest stable release of the library.
+**Fakernaija** requires **Python 3.10** or higher, and installing it is easy-peasy with ``pip``.
 
 .. code-block:: console
 
@@ -47,16 +47,19 @@ The primary interface you will interact with is the :doc:`naija`. The ``Naija``
     Ugochi Maduike
 
     >>> print(naija.state_capital())
-    Owerri
+    Damaturu
 
-    >>> print(naija.course_name())
-    Introduction to Computer Science
+    >>> print(naija.school_name())
+    University of Nigeria, Nsukka
+
+    >>> print(naija.phone_number())
+    09039294684
 
-    >>> print(naija.degree_name())
-    Bachelor of Pharmacy
+    >>> print(naija.email())
+    ololadelawal@hotmail.com
 
-    >>> print(naija.faculty_name())
-    Pharmaceutical Sciences
+    >>> print(naija.license_plate())
+    YLA-435EH
 
 **Fakernaija** tries to ensure that each method call returns different results within the same session until all possible outcomes are exhausted:
 

docs/source/naija.rst

@@ -57,6 +57,7 @@ Each method of the ``Naija`` class has its own documentation, complete with usag
    naija/degree
    naija/email
    naija/faculty
+   naija/license_plate
    naija/marital_status
    naija/name
    naija/phonenumber

docs/source/naija/license_plate.rst

@@ -0,0 +1,4 @@
+LicensePlate
+============
+
+.. autofunction:: fakernaija.Naija.license_plate

fakernaija/__init__.py

@@ -3,7 +3,7 @@
 This package provides utilities to generate random data with a Nigerian context.
 """
 
-__version__ = "1.0.4"
+__version__ = "1.0.5"
 
 from .naija import Naija
 

fakernaija/commands/__init__.py

@@ -8,6 +8,7 @@
     faculty,
     faculty_name,
 )
+from .license_plate import license_plate
 from .marital_status import marital_status
 from .name import first_name, full_name, last_name, prefix
 from .phonenumber import phone_number
@@ -36,6 +37,8 @@
     "faculty",
     "faculty_name",
     "department_name",
+    # License plate command
+    "license_plate",
     # Marital status command
     "marital_status",
     # Name commands

fakernaija/commands/license_plate.py

@@ -0,0 +1,79 @@
+"""License plate command to return random license plates data."""
+
+import click
+
+from fakernaija import Naija
+from fakernaija.utils import generate_command_data, handle_command_output
+
+naija = Naija()
+
+
+@click.command()
+@click.option(
+    "--repeat",
+    "-r",
+    default=1,
+    help="Number of random license plates to return. Defaults to 1.",
+    type=int,
+)
+@click.option(
+    "--state",
+    "-s",
+    default=None,
+    help="Generate plate numbers from any state LGA in Nigeria.",
+    type=str,
+)
+@click.option(
+    "--output",
+    "-o",
+    default=None,
+    help="The format of the output file.",
+    type=click.Choice(["json", "csv", "text"], case_sensitive=False),
+)
+def license_plate(repeat: int, state: str, output: str) -> None:
+    """Generate and returns random license plates.
+
+    Args:
+        repeat (int): The number of random license plates to return.
+            Must be a positive integer. Defaults to 1.
+        state (str): Generate license plate number by state.
+        output (str): The format of the output file if provided.
+
+    Note:
+        - Output options: csv, json, text
+        - State options: 36 states in Nigeria + FCT
+
+    Examples:
+        To generate a single random license plate:
+
+        .. code-block:: bash
+
+            $ naija license_plate
+            FST-452UB
+
+        To generate 3 random license plates:
+
+        .. code-block:: bash
+
+            $ naija license_plate --repeat 3
+            LND-718GQ
+            BWR-486US
+            AAA-182DD
+
+        To generate a random license plate from a specific state in Nigeria:
+
+        .. code-block:: console
+
+            $ naija license_plate --state "akwa ibom"
+            NGD-631CK
+
+        To generate 30 random license plate numbers and save them to a specified format:
+
+        .. code-block:: bash
+
+            $ naija license_plate --repeat 30 --output text
+            Generated data saved to /path/to/directory/filename.ext
+    """
+    data = generate_command_data(repeat, naija.license_plate, state=state)
+    if data:
+        handle_command_output(data, output, "license_plate", "license plates")