luhn-formula 1.0.5

Number validator and generator based on luhn's formula

luhn-formula

Another python package of number validator and check digit generator based on Luhn's formula 😉. Luhn's formula was designed to protect against accidental input errors.

Usage

install

pip install luhn-formula

or

git clone [e-mail]:code-127/luhn-formula-py.git

Example

>>> from luhnformula import luhnformula as lf
>>> lf.getcheckdigit("12345")
'5'
>>> lf.addcheckdigit("12345")
'123455'
>>> lf.isvalid("123455")
True

Function

checksum(number: str) -> int

Checksum vith the luhn formula
Args:
    number : Number to calculate
return:
    Result of luhn formula

isvalid(number: str) -> bool:

Validate number with the Luhn formula.
Args:
    number: Number to validate.
Returns:
    ``True`` when the: number is valid, otherwise ``False``.

getcheckdigit(number: str) -> str:

Generate check digit with the Luhn formula for a number.
Args:
    number: Number used to generate the check digit.
Return:
    the check digit for a number.
Raise error:
    ValueError : Invalid number.

addcheckdigit(number: str) -> str:

Generate and add check digit with the luhn formula for a number
Args:
    number: Number used to generate the check digit.
Return:
    the number with the check digit.
Raise error:
    ValueError : Invalid number.