Skip to main content

RANDOM.ORG JSON-RPC API (release 2) Python 3 implementation.

Project description

RANDOM.ORG JSON-RPC API (Release 2) implementation.

This is a Python 3 implementation of the RANDOM.ORG JSON-RPC API (R1). It provides either serialized or unserialized access to both the signed and unsigned methods of the API through the RandomOrgClient class. It also provides a convenience class through the RandomOrgClient class, the RandomOrgCache, for precaching requests. In the context of this module, a serialized client is one for which the sequence of requests matches the sequence of responses.

Installation

To install, simply: pip install rdoclient-py3

The base RDO implementation only requires the requests library: pip install requests. However, this package (rdoclient-py3) requires additional dependencies:

pip install -r requirements

Tests

Secure an API key and run the tests

Note that to run the accompanying tests the API_KEY fields must be given authentic values. Get an API key from here. Run tests like so:

py.test test_rdoclient.py

Usage

The default setup is best for non-time-critical serialized requests, eg, batch clients:

>>> from rdoclient import RandomOrgClient
>>> r = RandomOrgClient(YOUR_API_KEY_HERE)
>>> r.generate_integers(5, 0, 10)
[6, 2, 8, 9, 2]

…or for more time sensitive serialized applications, eg, real-time draws, use:

>>> r = RandomOrgClient(YOUR_API_KEY_HERE, blocking_timeout=2.0, http_timeout=10.0)
>>> r.generate_signed_integers(5, 0, 10)
{'random': {u'min': 0, u'max': 10, u'completionTime': u'2014-05-19 14:26:14Z', u'serialNumber': 1482, u'n': 5, u'base': 10, u'hashedApiKey': u'HASHED_KEY_HERE', u'data': [10, 9, 0, 1, 5], u'method': u'generateSignedIntegers', u'replacement': True}, 'data': [10, 9, 0, 1, 5], 'signature': u'SIGNATURE_HERE'}

If obtaining some kind of response instantly is important, a cache should be used. A cache will populate itself as quickly and efficiently as possible allowing pre-obtained randomness to be supplied instantly. If randomness is not available - eg, the cache is empty - the cache will return an Empty exception allowing the lack of randomness to be handled without delay:

>>> r = RandomOrgClient(YOUR_API_KEY_HERE, blocking_timeout=60.0*60.0, http_timeout=30.0)
>>> c = r.create_integer_cache(5, 0, 10)
>>> try:
...     c.get()
... except Queue.Empty:
...     # handle lack of true random number here
...     # possibly use a pseudo random number generator
...
[1, 4, 6, 9, 10]

Note that caches don’t support signed responses as it is assumed that clients using the signing features want full control over the serial numbering of responses.

Finally, it is possible to request live results as-soon-as-possible and without serialization, however this may be more prone to timeout failures as the client must obey the server’s advisory delay times if the server is overloaded:

>>> r = RandomOrgClient(YOUR_API_KEY_HERE, blocking_timeout=0.0, http_timeout=10.0, serialized=False)
>>> r.generate_integers(5, 0, 10)
[3, 5, 2, 4, 8]

Documentation

For a full list of available randomness generation functions and other features see rdoclient.py documentation and this link.

Change log

  • 2017-07-15 Release 2.0.1: Converted README.md to RST for PyPi

  • 2017-07-15 Release 2.0.0: Initial release. Added to PyPi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rdoclient-py3-2.0.1.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

rdoclient_py3-2.0.1-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file rdoclient-py3-2.0.1.tar.gz.

File metadata

File hashes

Hashes for rdoclient-py3-2.0.1.tar.gz
Algorithm Hash digest
SHA256 846d9a4727b064c7f139cb8ef5cc2c0acbfa3547cd9c46945c39b96510de3565
MD5 ffc628ce67f9516ba7d5f08d2d5a87ed
BLAKE2b-256 114527ad31ff228431cbd174de36303907e8c1d1a6ba55159109577ee90aab2e

See more details on using hashes here.

File details

Details for the file rdoclient_py3-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for rdoclient_py3-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d96cf18167b0d71e24dc224854de8bafdeccf40ce6530f8ea59f034dad69056b
MD5 f7e346c22fa443a7de33ed58717263bd
BLAKE2b-256 aff5d02fce483cf141d078262b65658cf5c08d4658c362f1595a14afab9398e1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page