- Code monger is a simple Python package for generation and validation of authentication codes which are generated and stored in files .
- For example , you can use this package when generating authentication codes for authenticating user email addresses in a web application .
- Check out the Release notes to stay updated .
- Ideas are welcome, contribute !!
- More is on the way .
- You can install the package easily on the command using pip
- Oh , none need installing ,every dependency comes with python ( Python Standard Library )
- The main libraries used are :
- string
- random
- os
python3 -m pip install code_monger
alternatively
pip install code_monger
or
py -m pip install code_monger
To upgrade your version in Windows ,just use the --upgrade option when installing . Like so :
python -m pip install --upgrade code_monger
- Let us generate a simple code based on the provided parameters
from code_monger import generate_code
# generates the code and returns it as a string object
my_code = generate_code(length = 20 )
print("Code generated : ", my_code)
- Let us generate a custom code
from code_monger import generate_code
# A code comprising of numbers only
numbers_only = generate_code(numbers = True , letters = False)
# Letters only code
letters_only = generate_code(numbers = False , letters = True )
# Uppercase Letters only code
uppercase_letters_only = generate_code(casing = "upper" , letters = True )
# Lowercase Letters only code
lowercase_letters_only = generate_code(casing = "lower" , letters = True )
# code made up of letters, numbers and punctuation charachters
all_types_of_charachters = generate_code(numbers = True , letters = True , punctuation_chars = True)
Please NOTE : generate_code function and CodeGenerator.NewCode method require the same keyword arguments with the exception that CodeGeneratorNewCode requires the key_string argument
- The class CodeGenerator is what we will use for this functionality
from code_monger import CodeGenerator
# specify the path you want to store the codes
# If the path doesnt exist , the program will attempt to make it
# Let's replicate a scenario where you want to authenticate a user's email in a web app
user_email = "somerandom@email.com"
codes_file = "codes/my_codes.txt"
cg = CodeGenerator(storage_file = codes_file)
# let us generate a new code and store it in this variable ,
# the code is automatically saved in the file provided during initialization of CodeGenerator
code = cg.NewCode(key_string = user_email )
# validation can be done through the CodeGenerator.ValidateCode method like so:
cg.ValidateCode(user_email , code)
# will return a Boolean , True if the code is valid else False