updated docu
This commit is contained in:
parent
71bc93b7b7
commit
8832a105c3
3 changed files with 19 additions and 8 deletions
23
README.md
23
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# randonautentropy
|
||||
# RandonautEntroPy
|
||||
|
||||
[](https://pypi.org/project/randonautentropy/) [](https://pypi.org/project/randonautentropy/)
|
||||
|
||||
|
|
@ -9,6 +9,9 @@ This project provides tools for interacting with the Randonautica Quantum and Te
|
|||
```
|
||||
$ pip install randonautentropy
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Python API
|
||||
|
||||
The randonautentropy Python module contains low-level `get` functions.
|
||||
|
|
@ -21,6 +24,15 @@ The randonautentropy Python module contains low-level `get` functions.
|
|||
|
||||
e5b779d67eda68636cb9
|
||||
|
||||
>>> temporal.get(length=10, channel=0)
|
||||
|
||||
d0c7ca53cb57ede1be14
|
||||
```
|
||||
|
||||
### Extended Functionality
|
||||
|
||||
The `rndo.get` function can also retrieve a single 32bit random number in different formats:
|
||||
```Python
|
||||
>>> rndo.get(type='int32')
|
||||
|
||||
-968449906
|
||||
|
|
@ -36,17 +48,18 @@ e5b779d67eda68636cb9
|
|||
>>> rndo.get(type='base64')
|
||||
|
||||
JA==
|
||||
```
|
||||
The `temporal.get` method can switch from the default high quality entropy mode to a faster but slightly lower entropy mode by switching its `channel` to 1.
|
||||
|
||||
>>> temporal.get(length=10, channel=0)
|
||||
|
||||
d0c7ca53cb57ede1be14
|
||||
|
||||
```Python
|
||||
>>> temporal.get(channel=1)
|
||||
|
||||
b83a7fd79bee5b3b1ad7
|
||||
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Command Line Interface
|
||||
|
||||
The package also comes with a `rndo` CLI:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue