LucaCappelletti94/random_italian_person

View on GitHub
README.rst

Summary

Maintainability
Test Coverage
random_italian_person
=========================================================================================
|pip| |downloads| |github|

Python package to generate an Italian person randomly.

How do I install this package?
----------------------------------------------
As usual, just download it using pip:

.. code:: shell

    pip install random_italian_person


Usage examples
-----------------------------------------------

.. code:: python

    from random_italian_person import RandomItalianPerson

    person = RandomItalianPerson()

    print(person.describe())
    # 'Rodrigo Benedetti รจ nata/o a Molazzana (LU) il 1972-12-18. Ora vive a Cagliari (CA) in Via Giuseppe Garibaldi 109.'

Generate a CSV of random italian persons
-----------------------------------------------
One of the most common usages for this library is to render
fake datasets for testing porposes. For instance,
to generate a CSV with 5 random person you can use:

.. code:: python

    import pandas as pd
    from random_italian_person import RandomItalianPerson

    df = pd.DataFrame([
        RandomItalianPerson().data
        for _ in range(5)
    ])

The obtained dataframe will look like:

+-----------------------+------------+-----------+-----------+-------+----------------------+------------------+----------------+-------------+-----------------------+-------------+-------------------+----------------+-------+----------------+-----------------+------------------+
| region                | province   | surname   | name      | sex   | birth_municipality   | birth_province   | birth_region   |   birth_cap | birth_province_code   | birthdate   | address           | house_number   |   cap | municipality   | province_code   | codice_fiscale   |
+=======================+============+===========+===========+=======+======================+==================+================+=============+=======================+=============+===================+================+=======+================+=================+==================+
| Marche                | Macerata   | Di Felice | Giacomina | F     | Mosciano Sant'angelo | Teramo           | Abruzzo        |       64023 | TE                    | 1945-09-18  | Viale De Amicis   | 76             | 62020 | Colmurano      | MC              | DFLGMN45P58F764B |
+-----------------------+------------+-----------+-----------+-------+----------------------+------------------+----------------+-------------+-----------------------+-------------+-------------------+----------------+-------+----------------+-----------------+------------------+
| Friuli Venezia Giulia | Udine      | Galli     | Imen      | F     | Isola Dovarese       | Cremona          | Lombardia      |       26031 | CR                    | 1942-03-10  | Via Udine         | 2              | 33020 | Verzegnis      | UD              | GLLMNI42C50E356T |
+-----------------------+------------+-----------+-----------+-------+----------------------+------------------+----------------+-------------+-----------------------+-------------+-------------------+----------------+-------+----------------+-----------------+------------------+
| Abruzzo               | Pescara    | Rosso     | Eva       | F     | Cellarengo           | Asti             | Piemonte       |       14010 | AT                    | 2001-12-31  | Via G. Fonzi      | 58             | 65010 | Spoltore       | PE              | RSSVEA01T71C438U |
+-----------------------+------------+-----------+-----------+-------+----------------------+------------------+----------------+-------------+-----------------------+-------------+-------------------+----------------+-------+----------------+-----------------+------------------+
| Emilia Romagna        | Bologna    | Grasso    | Emanuele  | M     | Caposele             | Avellino         | Campania       |       83040 | AV                    | 1942-08-27  | Via G. Massarenti | 223/5          | 40138 | Bologna        | BO              | GRSMNL42M27B674L |
+-----------------------+------------+-----------+-----------+-------+----------------------+------------------+----------------+-------------+-----------------------+-------------+-------------------+----------------+-------+----------------+-----------------+------------------+
| Sicilia               | Palermo    | Pastorino | Lenuta    | F     | Borzonasca           | Genova           | Liguria        |       16041 | GE                    | 1972-09-05  | Via Montalbo      | 124            | 90142 | Palermo        | PA              | PSTLNT72P45B067T |
+-----------------------+------------+-----------+-----------+-------+----------------------+------------------+----------------+-------------+-----------------------+-------------+-------------------+----------------+-------+----------------+-----------------+------------------+


.. |pip| image:: https://badge.fury.io/py/random-italian-person.svg
    :target: https://badge.fury.io/py/random-italian-person
    :alt: Pypi project

.. |downloads| image:: https://pepy.tech/badge/random-italian-person
    :target: https://pepy.tech/badge/random-italian-person
    :alt: Pypi total project downloads

.. |github| image:: https://github.com/lucacappelletti94/random_italian_person/actions/workflows/python.yml/badge.svg
    :target: https://github.com/lucacappelletti94/random_italian_person/actions
    :alt: Github Actions