fast-luhn

Fast Luhn algorithm


Keywords
luhn, validation, checksum, credit-card, luhn-algorithm
License
MIT
Install
pip install fast-luhn==0.1.5

Documentation

fast-luhn

Luhn-algorithm. Generate and validate strings of numbers. It is used for account number validation, credit card validation, data verification, cryptography, decoding, etcetera. Rust realization for speed-up python code. Thread-safe. See benchmark for details.

Author: Matt Stroganov
Version: 0.1.5

Installation

Install with pip:

$ pip install fast-luhn

Usage

Import package:

>>> import fast_luhn as fl

Validate

Check if string is valid by luhn algorithm. Return bool.

>>> fl.validate("471629309440")
False

Digit

Calculate next digit for string of numbers. Return int.

>>> fl.digit("47162930944")
7

Complete

Add luhn-check digit to string of numbers. Return string.

>>> fl.complete("2398560146")
'23985601469'

Generate

Generate luhn-valid string of numbers with length. Return string.

>>> fl.generate(50)
'58126333877729238938910323395262199130041545367401'

Build

Install from sources:

$ git clone https://github.com/cybermatt/fast-luhn
$ cd fast-luhn
$ pip install -r requirements-dev.txt
$ python ./setup.py develop

Benchmark

Pure python realization (from here) was very slow.

Comparison with popular python Luhn modules:

method lib luhn LAP fast-luhn
validate 4.65 µs 13.3 µs 0.2 µs
generate 48.1 µs 94.4 µs 3.17 µs

Environment:

  • CPU i5-6500 3.20GHz, 16gb RAM
  • Linux 4.19
  • Python 3.7.3

Tests

$ pytest -v tests.py

License

This project is licensed under the MIT License - see the LICENSE.txt file for details