Metadata-Version: 1.1
Name: python-codicefiscale
Version: 0.3.4
Summary: python-codicefiscale is a tiny library for encode/decode Italian fiscal code - codifica/decodifica del Codice Fiscale.
Home-page: https://github.com/fabiocaccamo/python-codicefiscale
Author: Fabio Caccamo
Author-email: fabio.caccamo@gmail.com
License: MIT
Download-URL: https://github.com/fabiocaccamo/python-codicefiscale/archive/0.3.4.tar.gz
Description: |Build Status| |codecov| |Code Health| |Requirements Status| |PyPI version| |Py versions| |License|
        
        python-codicefiscale
        ====================
        
        python-codicefiscale is a tiny library for encode/decode Italian fiscal
        code - **codifica/decodifica del Codice Fiscale**.
        
        Features
        --------
        
        -  **Transliteration** for name/surname
        -  **Multiple** birthdate formats (datetime/string) *(you can see all the supported string formats in* ``tests/tests.py`` *)*
        -  **Automatic** birthplace city/foreign-country code detection from name
        -  **Omocodia** support
        
        Installation
        ------------
        
        ``pip install python-codicefiscale``
        
        Usage
        -----
        
        Import
        ^^^^^^
        
        .. code:: python
        
            from codicefiscale import codicefiscale
        
        Encode
        ^^^^^^
        
        .. code:: python
        
            codicefiscale.encode(surname='Caccamo', name='Fabio', sex='M', birthdate='03/04/1985', birthplace='Torino')
        
            # 'CCCFBA85D03L219P'
        
        Decode
        ^^^^^^
        
        .. code:: python
        
            codicefiscale.decode('CCCFBA85D03L219P')
        
            # {
            #     'code': 'CCCFBA85D03L219P',
            #     'sex': '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',
            #         'surname': 'CCC',
            #         'name': 'FBA',
            #         'birthdate': '85D03',
            #         'birthdate_year': '85'
            #         'birthdate_month': 'D',
            #         'birthdate_day': '03',
            #         'birthplace': 'L219',
            #         'cin': 'P',
            #     },
            # }
        
        Check
        ^^^^^
        
        .. code:: python
        
            codicefiscale.is_valid('CCCFBA85D03L219P')
        
            # True
        
        .. code:: python
        
            codicefiscale.is_omocode('CCCFBA85D03L219P')
        
            # False
        
        Test
        ~~~~
        
        ``tox`` / ``python setup.py test`` / ``python -m unittest tests.tests``
        
        --------------
        
        License
        -------
        
        Released under `MIT License`_.
        
        .. _MIT License: LICENSE
        
        .. |Build Status| image:: https://travis-ci.org/fabiocaccamo/python-codicefiscale.svg?branch=master
        .. |codecov| image:: https://codecov.io/gh/fabiocaccamo/python-codicefiscale/branch/master/graph/badge.svg
        .. |Code Health| image:: https://landscape.io/github/fabiocaccamo/python-codicefiscale/master/landscape.svg?style=flat
        .. |Requirements Status| image:: https://requires.io/github/fabiocaccamo/python-codicefiscale/requirements.svg?branch=master
        .. |PyPI version| image:: https://badge.fury.io/py/python-codicefiscale.svg
        .. |Py versions| image:: https://img.shields.io/pypi/pyversions/python-codicefiscale.svg
        .. |License| image:: https://img.shields.io/pypi/l/python-codicefiscale.svg
Keywords: codicefiscale,codice,fiscale,cf,fiscal code
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Build Tools
