Client library for accessing RecordKeepers Receiver
Project description
Context
RecordKeeper (abbreviated to RK) is aimed at two broad goals:
-
Explaining why something happened in your platform. Common example that we want to support is: why event X happened at time T? What Models were used? Who trained them, using training data ingested from which datasources? It achieves it by creating graph of events.
-
Recreating platform state at that time.
Basics
RKClient library is used to create events (PEMS) and inform RK about them.
You will need a running RecordKeeper Event Receiver to be able to work with it.
Recommended usage:
emitter_id = uuid.UUID('..some static uuid..')
rk_host = os.environ.get('RK_HOST')
rk_client = RKClientFactory.get(rk_host, emitter_id)
By using factory, automatically when RK_MOCK=true
env variable will be defined,
the returned client will fake the connections and return only success codes.
RKClient from Python console
cd rkclient/
python3
>>> from rkclient import RKAdmin
>>> rk = RKAdmin('http://127.0.0.1:8082')
>>> pems, msg, ok = rk.get_pems()
>>> assert ok, msg
>>> for pem in pems:
>>> print(pem)
RKClient is part of ERST Recordkeeper repository.
RKClient is licensed with GNU General Public License version 3 or later, see LICENSE file for details.
Recordkeeper is ERST's implementation of the Context Cartographer specification.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for RecordKeeper_Client-1.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1d9380d6ed4403a7fd1619c9a5a892c2e3fcaa259cea628b1985fd8f8850ac8 |
|
MD5 | d3803abeb143dc0c0cdc1024490b6f5f |
|
BLAKE2b-256 | a9f7aa212f0938cffc6092151dc1ea003d48113cdc3a80895582f56fb36231b0 |
Hashes for RecordKeeper_Client-1.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36476e27bc3d2681e17c41a1527d23f8eb07cd8dddd07dff15cff1569517d82e |
|
MD5 | ce59fbd647f395f3aff2c67f660c5f4f |
|
BLAKE2b-256 | 7af935dc6cf599f763243d93cf72c32ba46b01ec867a296afbe6c286d59207f8 |