.. image:: https://raw.githubusercontent.com/harens/checkdigit/master/art/logo.png
:alt: checkdigit logo
:target: https://github.com/harens/checkdigit
:align: center
|
.. image:: https://img.shields.io/github/actions/workflow/status/harens/checkdigit/test.yml?logo=github&style=flat-square
:alt: GitHub Tests status
:target: https://github.com/harens/checkdigit/actions
.. image:: https://img.shields.io/codecov/c/github/harens/checkdigit?logo=codecov&style=flat-square
:alt: Codecov
:target: https://app.codecov.io/gh/harens/checkdigit
.. image:: https://img.shields.io/pypi/dm/checkdigit?logo=python&logoColor=white&style=flat-square
:alt: PyPi - Downloads
:target: https://pepy.tech/project/checkdigit
.. image:: https://img.shields.io/codefactor/grade/github/harens/checkdigit?logo=codefactor&style=flat-square
:alt: CodeFactor Grade
:target: https://www.codefactor.io/repository/github/harens/checkdigit/
=========
.. image:: https://repology.org/badge/vertical-allrepos/python:checkdigit.svg
:alt: checkdigit repology
:target: https://repology.org/project/python:checkdigit/versions
:align: right
**checkdigit** is a pure Python library built for identification numbers.
You want to validate a credit card number, or maybe even calculate a missing digit on an ISBN code?
We've got you covered 😎.
Want to know more? Check out the `API Reference and documentation <https://checkdigit.readthedocs.io/en/latest/reference.html>`_!
Installation
------------
`MacPorts <https://ports.macports.org/port/py-checkdigit/summary>`_ 🍎
*************************************************************************
.. code-block::
sudo port install py-checkdigit
`PyPi <https://pypi.org/project/checkdigit/>`_ 🐍
**************************************************
.. code-block::
pip install checkdigit
✨ Features
------------
* 📦 Works out of the box with all `supported Python versions <https://endoflife.date/python>`_ (3.7-3.11).
* ⌨️ `PEP 561 compatible <https://www.python.org/dev/peps/pep-0561>`_, with built in support for type checking.
* 🏃 Zero runtime dependencies. What you see is what you get.
* 🧮 Capable of calculating missing digits or validating a block of data.
* 📝 Extensive in-code comments and docstrings to explain how it works behind the scenes.
✅ Supported Formats
---------------------
* `Even/Odd binary parity <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.parity.html#module-checkdigit.parity>`_
* `CRC <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.crc.html#module-checkdigit.crc>`_
* `GS1 Standards <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.gs1.html#module-checkdigit.gs1>`_
* EAN-8/13
* GDTI
* GLN
* SSCC
* UPC-A/E
* etc. *(all fixed length numeric GS1 data structures with a check digit)*
* `ISBN-10/13 <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.isbn.html#module-checkdigit.isbn>`_
* `Luhn <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.luhn.html#module-checkdigit.luhn>`_
* `Verhoeff <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.verhoeff.html#module-checkdigit.verhoeff>`_
For each of these formats, we provide functions to validate them and calculate missing digits.
Do you have any formats that you'd like to see supported? 🤔 Feel free to raise an issue,
or even to send a pull request!
🔨 Contributing
---------------
- Contributing Page: `<https://checkdigit.rtfd.io/en/latest/contributing.html>`_
- Issue Tracker: `<https://github.com/harens/checkdigit/issues>`_
- Source Code: `<https://github.com/harens/checkdigit>`_
Any change, big or small, that you think can help improve this project is more than welcome 🎉.
As well as this, feel free to open an issue with any new suggestions or bug reports. Every contribution is appreciated.
To find out more, please read our `contributing page <https://checkdigit.readthedocs.io/en/latest/contributing.html>`_. Thank you!
📙 License
-----------
This project is licensed under `GPL-3.0-or-later <https://github.com/harens/checkdigit/blob/master/LICENSE>`_.
Raw data
{
"_id": null,
"home_page": "https://checkdigit.rtfd.io",
"name": "checkdigit",
"maintainer": "harens",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "harensdeveloper@gmail.com",
"keywords": "Check Digits,Validation,ISBN,GS1,Luhn",
"author": "harens",
"author_email": "harensdeveloper@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4a/56/20c586918b2c4c12549bca8ddf2c23a238b9ad58d20d392724deb8034d9a/checkdigit-0.5.0.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/harens/checkdigit/master/art/logo.png\n :alt: checkdigit logo\n :target: https://github.com/harens/checkdigit\n :align: center\n\n|\n\n.. image:: https://img.shields.io/github/actions/workflow/status/harens/checkdigit/test.yml?logo=github&style=flat-square\n :alt: GitHub Tests status\n :target: https://github.com/harens/checkdigit/actions\n\n.. image:: https://img.shields.io/codecov/c/github/harens/checkdigit?logo=codecov&style=flat-square\n :alt: Codecov\n :target: https://app.codecov.io/gh/harens/checkdigit\n\n.. image:: https://img.shields.io/pypi/dm/checkdigit?logo=python&logoColor=white&style=flat-square\n :alt: PyPi - Downloads\n :target: https://pepy.tech/project/checkdigit\n\n.. image:: https://img.shields.io/codefactor/grade/github/harens/checkdigit?logo=codefactor&style=flat-square\n :alt: CodeFactor Grade\n :target: https://www.codefactor.io/repository/github/harens/checkdigit/\n\n=========\n\n.. image:: https://repology.org/badge/vertical-allrepos/python:checkdigit.svg\n :alt: checkdigit repology\n :target: https://repology.org/project/python:checkdigit/versions\n :align: right\n\n**checkdigit** is a pure Python library built for identification numbers.\nYou want to validate a credit card number, or maybe even calculate a missing digit on an ISBN code?\nWe've got you covered \ud83d\ude0e.\n\nWant to know more? Check out the `API Reference and documentation <https://checkdigit.readthedocs.io/en/latest/reference.html>`_!\n\nInstallation\n------------\n\n`MacPorts <https://ports.macports.org/port/py-checkdigit/summary>`_ \ud83c\udf4e\n*************************************************************************\n\n.. code-block::\n\n sudo port install py-checkdigit\n\n`PyPi <https://pypi.org/project/checkdigit/>`_ \ud83d\udc0d\n**************************************************\n\n.. code-block::\n\n pip install checkdigit\n\n\u2728 Features\n------------\n\n* \ud83d\udce6 Works out of the box with all `supported Python versions <https://endoflife.date/python>`_ (3.7-3.11).\n* \u2328\ufe0f `PEP 561 compatible <https://www.python.org/dev/peps/pep-0561>`_, with built in support for type checking.\n* \ud83c\udfc3 Zero runtime dependencies. What you see is what you get.\n* \ud83e\uddee Capable of calculating missing digits or validating a block of data.\n* \ud83d\udcdd Extensive in-code comments and docstrings to explain how it works behind the scenes.\n\n\u2705 Supported Formats\n---------------------\n\n* `Even/Odd binary parity <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.parity.html#module-checkdigit.parity>`_\n* `CRC <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.crc.html#module-checkdigit.crc>`_\n* `GS1 Standards <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.gs1.html#module-checkdigit.gs1>`_\n * EAN-8/13\n * GDTI\n * GLN\n * SSCC\n * UPC-A/E\n * etc. *(all fixed length numeric GS1 data structures with a check digit)*\n* `ISBN-10/13 <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.isbn.html#module-checkdigit.isbn>`_\n* `Luhn <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.luhn.html#module-checkdigit.luhn>`_\n* `Verhoeff <https://checkdigit.readthedocs.io/en/latest/_autosummary/checkdigit.verhoeff.html#module-checkdigit.verhoeff>`_\n\nFor each of these formats, we provide functions to validate them and calculate missing digits.\n\nDo you have any formats that you'd like to see supported? \ud83e\udd14 Feel free to raise an issue,\nor even to send a pull request!\n\n\ud83d\udd28 Contributing\n---------------\n\n- Contributing Page: `<https://checkdigit.rtfd.io/en/latest/contributing.html>`_\n- Issue Tracker: `<https://github.com/harens/checkdigit/issues>`_\n- Source Code: `<https://github.com/harens/checkdigit>`_\n\nAny change, big or small, that you think can help improve this project is more than welcome \ud83c\udf89.\n\nAs well as this, feel free to open an issue with any new suggestions or bug reports. Every contribution is appreciated.\n\nTo find out more, please read our `contributing page <https://checkdigit.readthedocs.io/en/latest/contributing.html>`_. Thank you!\n\n\ud83d\udcd9 License\n-----------\n\nThis project is licensed under `GPL-3.0-or-later <https://github.com/harens/checkdigit/blob/master/LICENSE>`_.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "A check digit library for data validation",
"version": "0.5.0",
"split_keywords": [
"check digits",
"validation",
"isbn",
"gs1",
"luhn"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25412f546c899c60d63cf07897c22677f88e3aa90c175abbf786a5b777f6b0af",
"md5": "e5c8d95bdac08b883109d56c8db7d555",
"sha256": "cc76a20005a1cedfaf8d3358d2a970788e994b16ccf7fbe2624f1a043b4a07cf"
},
"downloads": -1,
"filename": "checkdigit-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5c8d95bdac08b883109d56c8db7d555",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 27251,
"upload_time": "2023-04-09T12:36:15",
"upload_time_iso_8601": "2023-04-09T12:36:15.884483Z",
"url": "https://files.pythonhosted.org/packages/25/41/2f546c899c60d63cf07897c22677f88e3aa90c175abbf786a5b777f6b0af/checkdigit-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a5620c586918b2c4c12549bca8ddf2c23a238b9ad58d20d392724deb8034d9a",
"md5": "9d070cee98b260fd8bb111ae8305687c",
"sha256": "fe493397f2b95e4e726573a5a70b200f23b270e6d89c21847dea22024fe970e2"
},
"downloads": -1,
"filename": "checkdigit-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "9d070cee98b260fd8bb111ae8305687c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 22553,
"upload_time": "2023-04-09T12:36:17",
"upload_time_iso_8601": "2023-04-09T12:36:17.794335Z",
"url": "https://files.pythonhosted.org/packages/4a/56/20c586918b2c4c12549bca8ddf2c23a238b9ad58d20d392724deb8034d9a/checkdigit-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-09 12:36:17",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "checkdigit"
}
JSON