From 8832a105c3f5b1fc4225718a7facb618e6a62ab7 Mon Sep 17 00:00:00 2001 From: randogoth Date: Sat, 3 Jun 2023 10:44:19 +0300 Subject: [PATCH] updated docu --- LICENSE | 2 -- README.md | 23 ++++++++++++++++++----- setup.py | 2 +- 3 files changed, 19 insertions(+), 8 deletions(-) diff --git a/LICENSE b/LICENSE index bd9cff9..cf1a457 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,3 @@ -Copyright 2012-2013 Luke Macken -Copyright 2020 Jason Carpenter Copyright 2023 randogoth 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: diff --git a/README.md b/README.md index 556f463..4eb5706 100644 --- a/README.md +++ b/README.md @@ -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/) @@ -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: diff --git a/setup.py b/setup.py index 5678a5a..8270716 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ with open("README.md", "r") as fh: setuptools.setup( name="randonautentropy", - version="0.0.2", + version="1.0.2", author="randogoth", author_email="randogoth@posteo.org", description="Python API for interacting with The Randonautica Quantum Random Number Generator",