From e7265937e375088ae0b86e2586b68cd73a0337ea Mon Sep 17 00:00:00 2001 From: randogoth Date: Sun, 28 May 2023 22:49:23 +0300 Subject: [PATCH] init --- .gitignore | 8 ++++ LICENSE | 9 +++++ README.md | 70 ++++++++++++++++++++++++++++++++++ randonautentropy/__init__.py | 8 ++++ randonautentropy/cmd.py | 74 ++++++++++++++++++++++++++++++++++++ randonautentropy/rndo.py | 61 +++++++++++++++++++++++++++++ requirements.txt | 1 + setup.py | 26 +++++++++++++ 8 files changed, 257 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 randonautentropy/__init__.py create mode 100644 randonautentropy/cmd.py create mode 100644 randonautentropy/rndo.py create mode 100644 requirements.txt create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e3ad58f --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.egg* +*.pyc +*.swp +build/ +dist/ +.idea/ +venv/ +__pycache__/ \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bd9cff9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +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: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4a8783 --- /dev/null +++ b/README.md @@ -0,0 +1,70 @@ +# 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/) + +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. + +## Installation + +``` +$ pip install randonautentropy +``` +## Python API + +The randonautentropy Python module contains a low-level `get` function. + +```Python +>>> import randonautentropy as rndo + +>>> rndo.get(type='hex16', length=10) + +5b779d67eda68636cb90 + +>>> rndo.get(type='int32') + +-968449906 + +>>> rndo.get(type='uniform') + +0.9251141917698646 + +>>> rndo.get(type='normal') + +0.8924809489412333 + +>>> rndo.get(type='base64') + +JA== +``` + +## Command Line Interface + +The package also comes with a `rndo` CLI: + +``` +usage: rndo [-h] [--hex] [--int] [--uniform] [--gauss] [--base64] [bytes] + +A tool for printing random data from the Randonautica Quantum Random Number Generators + +positional arguments: + 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 + ``` + + ### Example: + + ``` + $ rndo 100 + d204ab96505929325292d84a1217ded8de5781a449be0371cdcc97e6f6b1fe69a6b530cdf7112250172e573fe7b42b9e89fe42eef198cce0ec7a427b74f59b7b7a3d8ecabfc0f0051fe06104b1dd7f2a7d1626d7f66aac5afe002bdb255ec136d52405c2 + + $ rndo -u + 0.12742354174572768 + ``` \ No newline at end of file diff --git a/randonautentropy/__init__.py b/randonautentropy/__init__.py new file mode 100644 index 0000000..ef68637 --- /dev/null +++ b/randonautentropy/__init__.py @@ -0,0 +1,8 @@ +import os +import glob + +from .rndo import * +from .cmd import * + +modules = glob.glob(os.path.dirname(__file__)+"/*.py") +__all__ = [ os.path.basename(f)[:-3] for f in modules if not f.endswith('__init__.py')] \ No newline at end of file diff --git a/randonautentropy/cmd.py b/randonautentropy/cmd.py new file mode 100644 index 0000000..a64f5b9 --- /dev/null +++ b/randonautentropy/cmd.py @@ -0,0 +1,74 @@ +# 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: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. +""" +A tool for printing random data from the Randonautica Quantum Random Number Generators +""" +from __future__ import print_function + +import sys +from . import rndo +import argparse + +def main(): + + parser = argparse.ArgumentParser(description="A tool for printing random data from the Randonautica Quantum Random Number Generators") + parser.add_argument("--hex", action="store_false", help="Hexadecimal entropy") + parser.add_argument("--int", "-i", action="store_true", help="Random 32 bit integer") + parser.add_argument("--uniform", "-u", action="store_true", help="Random uniform float") + parser.add_argument("--gauss", "--normal", "-g", "-n", action="store_true", help="Random normal distributed float") + parser.add_argument("--base64", "-b64", "-b", action="store_true", help="Random uniform float") + parser.add_argument("bytes", nargs="?", type=int, default=10, help="amount of hexadecimal bytes") + parser.print_usage = parser.print_help + args = parser.parse_args() + + generator = None + + if args.hex: + try: + bytes = int(args.bytes) + except ValueError: + sys.exit(1) + generator = rndo.get('hex16', bytes) + + if args.int: + print(rndo.get('int32')) + sys.exit(0) + + if args.uniform: + print(rndo.get('uniform')) + sys.exit(0) + + if args.gauss: + print(rndo.get('normal')) + sys.exit(0) + + if args.base64: + print(rndo.get('base64')) + sys.exit(0) + + if not generator: + sys.exit(1) + try: + print(generator) + except: + pass + +if __name__ == '__main__': + main() diff --git a/randonautentropy/rndo.py b/randonautentropy/rndo.py new file mode 100644 index 0000000..d65f718 --- /dev/null +++ b/randonautentropy/rndo.py @@ -0,0 +1,61 @@ +# 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: +# +# The above copyright notice and this permission notice shall be included in +# all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +# SOFTWARE. +""" +A Python interface to the Randonautica Quantum Random Numbers Server. + +""" + +import requests + +try: + from urllib.parse import urlencode +except ImportError: + from urllib import urlencode +import json + +from urllib3.exceptions import InsecureRequestWarning +requests.packages.urllib3.disable_warnings(InsecureRequestWarning) + +VERSION = '1.0.0' +URL = 'https://api.qrng.rndo.it/api/json/' +typeS = { + 'int32' : 'randint32', + 'hex16' : 'randhex', + 'uniform' : 'randuniform', + 'normal' : 'randnormal', + 'base64' : 'randbase64' +} + +DEVICE_ID = 'QWR70154' + +def get(type='hex', length=1): + """Fetch data from the Randonautica Quantum Random Numbers JSON API""" + if type not in typeS.keys(): + raise Exception("type must be one of %s" % typeS.keys()) + url = URL + typeS[type] + '?' + urlencode({ + 'device_id': DEVICE_ID, + 'length': length, + }) + data = __get_json(url) + return data + + +def __get_json(url): + return requests.get(url, verify=False).json() \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..77f80f9 --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +Requests==2.31.0 \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..5678a5a --- /dev/null +++ b/setup.py @@ -0,0 +1,26 @@ +import setuptools + +with open("README.md", "r") as fh: + long_description = fh.read() + +setuptools.setup( + name="randonautentropy", + version="0.0.2", + author="randogoth", + author_email="randogoth@posteo.org", + description="Python API for interacting with The Randonautica Quantum Random Number Generator", + long_description=long_description, + long_description_content_type="text/markdown", + url="https://github.com/randogoth/randonautentropy", + packages=setuptools.find_packages(), + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", + ], + entry_points= { + 'console_scripts': ['rndo=randonautentropy.cmd:main'] + }, + install_requires=['requests'], + python_requires='>=3.6', +) \ No newline at end of file