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.5.1rc55.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c475865ca9cc5a51d56ca1fddfa4cc9cd68cc772c2b78f331cff523341c2c5ff |
|
MD5 | 4ee30a8b94f7102925faa0155e63d6a8 |
|
BLAKE2b-256 | acb95616c632d1813e5277fe53e126e1d23797cba472f783a8237b76850e5698 |
Hashes for RecordKeeper_Client-1.5.1rc55-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ce80a4a8f6034ebc473f0be48c1a5f59fe0dc83b3e7a34b834cff7f9117d618 |
|
MD5 | 1447ff9072a7a7747e6dffc168fbbac9 |
|
BLAKE2b-256 | 00a17dfd3205e5ff4b8883881ef960cf99b59f63019a3a4cc50551f755be6bcd |