checkdigit

A check digit library for data validation.

Test Status
Version Info
Code Analysis

🔨 Installation

pip install checkdigit

Or download the project here.

✨ Features

• Contains various functions relating to Luhn, ISBN, UPC and many other codes.
• Extensive in-code comments and docstrings to explain how the functions work.
• Written in pure Python with no dependencies required to run the program.

Check out the documentation for more details on how to use the library.

🏗️ Contributing

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 valued.

For smaller tasks (that are still really appreciated 😃), be sure to check the good first issue tag.

💻 Setup

Clone the project and install the dev dependencies:

git clone https://github.com/harens/checkdigit
cd checkdigit
poetry install

If you want to send a PR, please run the following:

bash ./scripts/format.sh # Format files
bash ./scripts/tests.sh  # Run tests

# NB shellcheck is not installed by poetry
shellcheck scripts/*.sh

📒 License

This project is licensed under GPL-3.0-or-later.