merged temporal functionality

This commit is contained in:
randogoth 2023-06-02 00:58:58 +03:00
parent e7265937e3
commit f846c0e8ae
7 changed files with 84 additions and 99 deletions

View file

@ -2,7 +2,7 @@
[![PyPI version](https://badge.fury.io/py/randonautentropy.svg)](https://pypi.org/project/randonautentropy/) [![PyPI - License](https://img.shields.io/pypi/l/randonautentropy)](https://pypi.org/project/randonautentropy/)
This project provides tools for interacting with The Randonautica Quantum Random Number Generator. It communicates with the JSON API and provides a Python API, and a `rndo` command-line tool.
This project provides tools for interacting with the Randonautica Quantum and Temporal entropy generators. It provides a Python API, and a `rndo` command-line tool.
## Installation
@ -11,14 +11,15 @@ $ pip install randonautentropy
```
## Python API
The randonautentropy Python module contains a low-level `get` function.
The randonautentropy Python module contains low-level `get` functions.
```Python
>>> import randonautentropy as rndo
>>> from randonautentropy import rndo
>>> from randonautentropy import temporal
>>> rndo.get(type='hex16', length=10)
>>> rndo.get(length=10, type='hex16')
5b779d67eda68636cb90
e5b779d67eda68636cb9
>>> rndo.get(type='int32')
@ -35,6 +36,15 @@ The randonautentropy Python module contains a low-level `get` function.
>>> rndo.get(type='base64')
JA==
>>> temporal.get(length=10, channel=0)
d0c7ca53cb57ede1be14
>>> temporal.get(channel=1)
b83a7fd79bee5b3b1ad7
```
## Command Line Interface
@ -42,29 +52,25 @@ JA==
The package also comes with a `rndo` CLI:
```
usage: rndo [-h] [--hex] [--int] [--uniform] [--gauss] [--base64] [bytes]
usage: rndo [-h] [--rndo] [--temporal] [bytes]
A tool for printing random data from the Randonautica Quantum Random Number Generators
positional arguments:
bytes amount of hexadecimal bytes
bytes amount of hexadecimal bytes
options:
-h, --help show this help message and exit
--hex Hexadecimal entropy
--int, -i Random 32 bit integer
--uniform, -u Random uniform float
--gauss, --normal, -g, -n
Random normal distributed float
--base64, -b64, -b Random uniform float
-h, --help show this help message and exit
--rndo, -r Hexadecimal QRNG entropy
--temporal, -t Hexadecimal Temporal entropy
```
### Example:
```
$ rndo 100
$ rndo -r 100
d204ab96505929325292d84a1217ded8de5781a449be0371cdcc97e6f6b1fe69a6b530cdf7112250172e573fe7b42b9e89fe42eef198cce0ec7a427b74f59b7b7a3d8ecabfc0f0051fe06104b1dd7f2a7d1626d7f66aac5afe002bdb255ec136d52405c2
$ rndo -u
0.12742354174572768
$ rndo -t 100
93378573b635dc2b01ffd426068e6ccecbc2046fbc9598c1c41a4cbe0dcc8f62071202ea72d05b83581e8cd968cbd099ee0ccf37e9fbcd7d476bd4da6b1965434fc1a65302c732a06b6e5cebff37101a21926a34f1b236a4660a599c6ec93ae7296176fc
```