-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
13 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,19 +1,25 @@ | ||
# checkdigit | ||
[![Downloads](https://pepy.tech/badge/checkdigit)](https://pepy.tech/project/checkdigit) | ||
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/harens/checkdigit.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/harens/checkdigit/context:python) | ||
|
||
A check digit library for data validation | ||
|
||
| Test Status | [![GitHub Workflow Status](https://img.shields.io/github/workflow/status/harens/checkdigit/Tests?logo=github&style=flat-square)](https://github.com/harens/checkdigit/actions) [![Codecov](https://img.shields.io/codecov/c/github/harens/checkdigit?style=flat-square)](https://codecov.io/gh/harens/checkdigit) | | ||
|:--|:--| | ||
| __Version Info__ | [![PyPI](https://img.shields.io/pypi/v/checkdigit?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/checkdigit/) [![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/harens/checkdigit?logo=github&style=flat-square)](https://github.com/harens/checkdigit/releases) [![PyPI - Downloads](https://img.shields.io/pypi/dm/checkdigit?logo=python&logoColor=white&style=flat-square)](https://pypi.org/project/checkdigit/) | | ||
| __Code Analysis__ |[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/harens/checkdigit?logo=code%20climate&style=flat-square)](https://codeclimate.com/github/harens/checkdigit) [![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/harens/checkdigit?logo=codefactor&style=flat-square)](https://www.codefactor.io/repository/github/harens/checkdigit)| | ||
|
||
*A Python library for error detection via check digits* | ||
|
||
## Installation | ||
## 🔨 Installation | ||
```shell | ||
pip install checkdigit | ||
``` | ||
Or download the project [here](https://github.com/harens/checkdigit/archive/master.zip) | ||
|
||
## Usage | ||
## ✨ Features | ||
|
||
* Contains various functions relating to __Luhn, ISBN and UPC 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 [wiki](https://github.com/harens/checkdigit/wiki) for details on how to use the library | ||
Check out the [wiki](https://github.com/harens/checkdigit/wiki) for more details on how to use the library | ||
|
||
## License | ||
This project is licensed under the [GNU General Public License v3.0](https://github.com/harens/checkdigit/blob/master/LICENSE) |