randogoth/RandonautEntroPy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updated docu

Browse source
This commit is contained in:
randogoth 2023-06-03 10:44:19 +03:00
parent 71bc93b7b7
commit 8832a105c3
3 changed files with 19 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
LICENSE
View file

@ -1,5 +1,3 @@
Copyright 2012-2013 Luke Macken <lmacken@redhat.com>
Copyright 2020 Jason Carpenter <brad@identex.co>
Copyright 2023 randogoth <tobias@randonauts.com> Copyright 2023 randogoth <tobias@randonauts.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

23
README.md
View file

@ -1,4 +1,4 @@
# randonautentropy # RandonautEntroPy
[![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/) [![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/)
@ -9,6 +9,9 @@ This project provides tools for interacting with the Randonautica Quantum and Te
``` ```
$ pip install randonautentropy $ pip install randonautentropy
``` ```
---
## Python API ## Python API
The randonautentropy Python module contains low-level `get` functions. The randonautentropy Python module contains low-level `get` functions.
@ -21,6 +24,15 @@ The randonautentropy Python module contains low-level `get` functions.
e5b779d67eda68636cb9 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') >>> rndo.get(type='int32')
-968449906 -968449906
@ -36,17 +48,18 @@ e5b779d67eda68636cb9
>>> rndo.get(type='base64') >>> rndo.get(type='base64')
JA== 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) ```Python
d0c7ca53cb57ede1be14
>>> temporal.get(channel=1) >>> temporal.get(channel=1)
b83a7fd79bee5b3b1ad7 b83a7fd79bee5b3b1ad7
``` ```
---
## Command Line Interface ## Command Line Interface
The package also comes with a `rndo` CLI: The package also comes with a `rndo` CLI:

2
setup.py
View file

@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
setuptools.setup( setuptools.setup(
name="randonautentropy", name="randonautentropy",
version="0.0.2", version="1.0.2",
author="randogoth", author="randogoth",
author_email="randogoth@posteo.org", author_email="randogoth@posteo.org",
description="Python API for interacting with The Randonautica Quantum Random Number Generator", description="Python API for interacting with The Randonautica Quantum Random Number Generator",