AuthoRex 1.0.1

A package for generating and authenticating OTPs using MongoDB.

AuthoRex

AuthoRex is a Python package for generating and authenticating OTPs (One-Time Passwords) using MongoDB for storage. This package is useful for applications that require secure OTP-based authentication.

Features

• Generate OTPs for given phone numbers.
• Authenticate OTPs for given phone numbers.
• Uses MongoDB for storing OTPs securely.

Installation

You can install AuthoRex using pip:

pip install AuthoRex

Usage

Importing the package

You can import the entire package or specific functions:

import AuthoRex

# Or import specific functions
from AuthoRex import genOTP, authOTP

Generating an OTP

Generate an OTP for a given phone number:

# Using the package import
print(AuthoRex.genOTP("1234567890"))

# Using the function import
print(genOTP("1234567890"))

Authenticating an OTP

Authenticate an OTP for a given phone number:

# Using the package import
print(AuthoRex.authOTP("1234567890", 123456))  # Replace 123456 with the actual OTP generated

# Using the function import
print(authOTP("1234567890", 123456))  # Replace 123456 with the actual OTP generated

Example

Here's a complete example of how to use AuthoRex:

import AuthoRex

# Generate OTP for a phone number
response = AuthoRex.genOTP("1234567890")
print(response)

# Authenticate OTP for the same phone number
is_authenticated = AuthoRex.authOTP("1234567890", 123456)  # Replace 123456 with the actual OTP generated
print("Authenticated" if is_authenticated else "Authentication Failed")

MongoDB Configuration

AuthoRex uses MongoDB to store OTPs. Make sure you have a MongoDB instance running and update the MongoDB URI in the code as per your setup.

License

This project is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. See the LICENSE file for more details.

Author

AuthoRex is developed and maintained by TraxDinosaur. For any queries or support, you can reach out to TraxDinosaur.

Contributing

Contributions are welcome! Please fork the repository and submit a pull request for any improvements or bug fixes.

Acknowledgements

• The package uses pymongo for MongoDB interactions.