Skip to main content

A check digit library for data validation

Project description

checkdigit

A check digit library for data validation.

Test Status GitHub Workflow Status Codecov
Version Info PyPI GitHub tag (latest by date) PyPI - Downloads
Code Analysis Code Climate maintainability CodeFactor Grade LGTM Grade

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

checkdigit-0.1.1.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

checkdigit-0.1.1-py3-none-any.whl (21.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page