python-codicefiscale

python-codicefiscale is a library for encode/decode Italian fiscal code - codifica/decodifica del Codice Fiscale.

Codice Fiscale

Features

NEW Auto-updated data (once a week) directly from ANPR data-source.
NEW Command Line Interface available.
Transliteration for name/surname
Multiple birthdate formats (date/string) (you can see all the supported string formats here)
Automatic birthplace city/foreign-country code detection from name
Omocodia support

Installation

pip install python-codicefiscale

Usage

Python

Import

from codicefiscale import codicefiscale

Encode

codicefiscale.encode(
    lastname="Caccamo",
    firstname="Fabio",
    gender="M",
    birthdate="03/04/1985",
    birthplace="Torino",
)

# "CCCFBA85D03L219P"

Decode

codicefiscale.decode("CCCFBA85D03L219P")

# {
#     "code": "CCCFBA85D03L219P",
#     "gender": "M",
#     "birthdate": datetime.datetime(1985, 4, 3, 0, 0),
#     "birthplace": {
#         "name": "TORINO"
#         "province": "TO",
#         "code": "L219",
#     },
#     "omocodes": [
#         "CCCFBA85D03L219P",
#         "CCCFBA85D03L21VE",
#         "CCCFBA85D03L2MVP",
#         "CCCFBA85D03LNMVE",
#         "CCCFBA85D0PLNMVA",
#         "CCCFBA85DLPLNMVL",
#         "CCCFBA8RDLPLNMVX",
#         "CCCFBAURDLPLNMVU",
#     ],
#     "raw": {
#         "code": "CCCFBA85D03L219P",
#         "lastname": "CCC",
#         "firstname": "FBA",
#         "birthdate": "85D03",
#         "birthdate_year": "85"
#         "birthdate_month": "D",
#         "birthdate_day": "03",
#         "birthplace": "L219",
#         "cin": "P",
#     },
# }

Check

codicefiscale.is_valid("CCCFBA85D03L219P")

# True

codicefiscale.is_omocode("CCCFBA85D03L219P")

# False

Command Line

This library can be used also as a CLI tool, for more info run:

python -m codicefiscale --help

Encode (CLI)

python -m codicefiscale encode --firstname Fabio --lastname Caccamo --gender M --birthdate 03/04/1985 --birthplace Torino

Decode (CLI)

python -m codicefiscale decode CCCFBA85D03L219P

Testing

# clone repository
git clone https://github.com/fabiocaccamo/python-codicefiscale.git && cd python-codicefiscale

# create virtualenv and activate it
python -m venv venv && . venv/bin/activate

# upgrade pip
python -m pip install --upgrade pip

# install requirements
pip install -r requirements.txt -r requirements-test.txt

# install pre-commit to run formatters and linters
pre-commit install --install-hooks

# run tests using tox
tox

# or run tests using unittest
python -m unittest tests.tests

License

Released under MIT License.

Supporting

⭐ Star this project on GitHub
:octocat: Follow me on GitHub
💙 Follow me on Twitter
💰 Sponsor me on Github

Metadata

Release files for python-codicefiscale 0.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-codicefiscale 0.9.0
File	Size	Uploaded
python-codicefiscale-0.9.0.tar.gz	417.7 kB	Nov 6, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for python-codicefiscale 0.9.0
File	Interpreter	ABI	Platform	Reset
python_codicefiscale-0.9.0-py3-none-any.whl 429.7 kB Nov 6, 2023	Python 3	none	any	Details

Total release size: 847.3 kB

Release files / python-codicefiscale-0.9.0.tar.gz

Download URL	python-codicefiscale-0.9.0.tar.gz
Size	417.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`a3fef66bcc5ec7f582b340b237f4a078ec8ba877723362fec428a0a0d9023181`
BLAKE2b-256 checksum How to use checksums	`c122ee7fb4a56c03c1e39d73e3090ae0b36bddaaee5053253ec666a650dff665`
Upload date	Nov 6, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.6`

Release files / python_codicefiscale-0.9.0-py3-none-any.whl

Download URL	python_codicefiscale-0.9.0-py3-none-any.whl
Size	429.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6801e31dc40507b254bc110139c66d809f652c3647a65b20c5570d2f25aea368`
BLAKE2b-256 checksum How to use checksums	`99b154fae9cd9ab662f7db4c9ab8477f52960588bfc8d422371fd5b38c0d66cd`
Upload date	Nov 6, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.2 CPython/3.11.6`