Skip to main content

A random number generator based on shuffled English words, their ASCII values, and the current epoch time to create highly randomized outputs

Project description

random_algorithm

A very simple random algo made while thinking too much about it
PyPI - Version PyPI - Downloads Pepy Total Downlods

random_algorithm is a Python library that generates random numbers using a novel approach based on English words and the current epoch time. It utilizes ASCII values of shuffled words, reduces them to single digits, and combines these digits to generate a random number of a specified size. This implementation attempts to get as close as possible to true randomness by using time-based factors and word shuffling.

Features

  • Generates random numbers based on shuffled English words.
  • ASCII values of each word are reduced to single digits.
  • Supports dynamic generation of random numbers of any specified size.
  • Includes special logic to generate lower numbers (like 0 or 1), which can sometimes be difficult to produce with traditional randomization methods.

Usage

  1. Install the package in your repo
pip install random_algorithm

If you use a requirements file, add this line to it :

random_algorithm==1.0.0

You can import and use the library in your Python code like this :

from random_algorithm import gen_random

Generate a random number with a desired size of 5 digits :

random_number = gen_random(desired_size=5)
print(f"Generated random number : {random_number}")

Note that we also export the internal function ascii_reduce() :

  • ascii_reduce(word, index) : Takes a word in input (ex "github") and an index (can be any positive number). It then reduces the word to a single number (returns an int).

Handling errors

gen_random() will raise the following exceptions if invalid inputs are provided :

  • TypeError : Raised when desired_size is not an integer.
  • ValueError : Raised when desired_size is less than 1.

[!WARNING]
The code works fine but isn't the most optimized ever.
Generating huge numbers will take a lot of time ! I you really need a big random number, call the function multiple times with low numbers (ex 1 or 2) and concatenate the results

How it works

  1. Word shuffling : The words from wordlist.txt are shuffled on each call to ensure randomness.
  2. Random index : The current epoch time is used to generate a random index into the shuffled word list.
  3. ASCII reduction : Each word's ASCII values are reduced to single digits and then summed to produce a random number.
  4. Low numbers handling : A special condition ensures that numbers like 0 and 1 can be generated using the current epoch time modulo operations.

Contributing

Feel free to open an issue or a pull request if you want to contribute to this project

How to build ?

py -m pip install --upgrade pip build twine setuptools wheel
py -m build
py -m twine check dist/*
# Optional : publish to test.pypi.org
py -m twine upload --repository testpypi dist/*
# Or to pypi.org
py -m twine upload dist/*

License

This project is licensed under the MIT License - see the LICENSE file for details.
The wordlist comes from from https://github.com/dwyl/english-words

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

random_algorithm-1.0.0.tar.gz (1.1 MB view hashes)

Uploaded Source

Built Distribution

random_algorithm-1.0.0-py3-none-any.whl (1.1 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page