Installation

Install the released version:

pip install identifier-tools

Usage

Basic usage is to verify if the identifier has correct format, or if the identifier can be used in particular country:

>>> from identifier_tools.formats import verify_identifier_format, verify_national_identifier_country
>>> verify_identifier_format(identifier_type="GEN_VAT_CD", identifier="1111")
True
>>> verify_national_identifier_country(country_code="SK", national_id_type="SK_ICO_CD")
True

You can list all available identifiers in a particular country. Some countries has multiple identifiers with different priority, you can get the identifier rank as well:

>>> from identifier_tools.formats import get_country_identifiers, get_identifier_rank
>>> get_country_identifiers("DE")
[(1, 'DE_TRD_RGSTR_CD'), (2, 'DE_VAT_CD'), (3, 'DE_TAX_CD'), (4, 'DE_NOTAP_CD')]
>>> get_identifier_rank("DE_TAX_CD")
3

If you want to manually verify the identifier, it is possible to find a link provided by ECB:

>>> from identifier_tools.mappers import get_verification_register
>>> get_verification_register('SK_ICO_CD')
'https://rpo.statistics.sk/rpo'
>>> get_verification_register('US_EIN_CD')
('https://www.irs.gov/businesses/small-businesses-self-employed/employer-id-numbers-eins', 'https://eintaxid.com/')

Development

We look forward to any kind of improvements and support for new identifiers.

If you do add support for any identifier, checksum, etc. please add a link to the specific documentation that was used for implementation, so we can reference to it.

Clone a repository locally and make sure you work in your own branch and once you are happy with the functionality create pull request. All new code should be covered with tests. We try to use test driven development for the project.

If you find a bug feel free to create an issue with description, how ever we appreciate even more if you create failing test.

Release

Release is done via twine. The whole package is uploaded in the form of .dist file.

To create .dist file use command:

python setup.py sdist bdist_wheel

Now our binary .dist file is created, now we need to upload it using the below command:

python -m twine dist/*

Alternatively if you want to selfhost in a custom PyPI repo you can also upload there as well:

python -m twine upload--repository-url https://gitlab.com/custom/repo/path dist/* --cert /custom/cert

pytest identifier_tools