fabiocaccamo/python-codicefiscalePublic

NotificationsYou must be signed in to change notification settings
Fork25
Star80

🇮🇹 💳 italian fiscal codes encoding, decoding and validation - codifica, decodifica e validazione del Codice Fiscale italiano.

License

MIT license

80 stars 25 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 579 Commits
.github		.github
images		images
scripts		scripts
src/codicefiscale		src/codicefiscale
tests		tests
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE.txt		LICENSE.txt
MANIFEST.in		MANIFEST.in
README.md		README.md
SECURITY.md		SECURITY.md
pyproject.toml		pyproject.toml
requirements-data.txt		requirements-data.txt
requirements-test.txt		requirements-test.txt
requirements.txt		requirements.txt
setup.py		setup.py
tox.ini		tox.ini

Repository files navigation

python-codicefiscale

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

Features

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

Installation

pip install python-codicefiscale

Usage

Python

Import

fromcodicefiscaleimportcodicefiscale

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 repositorygit clone https://github.com/fabiocaccamo/python-codicefiscale.git&&cd python-codicefiscale# create virtualenv and activate itpython -m venv venv&&. venv/bin/activate# upgrade pippython -m pip install --upgrade pip# install requirementspip install -r requirements.txt -r requirements-test.txt# install pre-commit to run formatters and linterspre-commit install --install-hooks# run tests using toxtox# or run tests using pytestpytest