To return a list of randomly drawn numbers from a user defined list of numbers.
Project description
random_number_list
Creates a list of randomly drawn numbers from a larger list. Can be used to pick lottery numbers.
Installation
Run the following to install:
pip install random-number-list
Usage
from random_number_list import RandomNumberList
new_list = RandomNumberList.return_list(number, pick, put_back)
print(new_list)
print(RandomNumberList.verify_number(number))
print(RandomNumberList.verify_pick(number, pick))
Example
new_list = RandomNumberList.return_list(15, 5, False)
print(new_list)
returns:
[12, 9, 1, 8, 4]
Basis of operation
When the object is called, you pass the following variables:
number:
The number of items in the pool to be picked from.
example:
number = 5 will create a pool [1, 2, 3, 4, 5]
pick:
The number of items to be randomly drawn from the pool.
example:
pick = 2 will return a list of the randomly drawn items, say [4, 2]
put_back:
Whether an item is put back into the pool prior to the next draw.
Input as a boolean True or False, with a default of False.
error_text:
Optional Boolean variable with a default of False.
If True is passed, a simple explanatory error message is output.
Note:
digits after a decimal point are ignored.
5, 5.0, 5.2 & 5.9 all equate to 5
Methods
RandomNumberList.return_list(number, pick, put_back, error_text)
Used to create the list of randomly drawn numbers:
RandomNumberList.verify_number(number, error_text)
Validates that a number greater than or equal to one has been passed.
RandomNumberList.verify_pick(number, pick, error_text)
Validates that:
number: is greater than or equal to one
pick: is greater than or equal to one AND less than or equal to number
Install Requires
This package uses the following standard library packages:
- random
In Closing
This package has been built as part of my learning Python so may contain coding that is not best practice. I am happy for more experienced Python users to feedback any areas that could be improved. Once I get to understand uploading packages to PyPI I will set up development dependencies.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for random_number_list-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bed636a6eff25a2a924cee0e79d6277a0582f298f9de39c2c583c3211057d0a9 |
|
MD5 | cf851f6899ca93bece2fdeb4241b06d8 |
|
BLAKE2b-256 | b99b279f312648a1f226f28aeacc2e0fe96ac26c30ae836b3cb9f82f00671309 |