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)
Releasing package on PIP
Initial setup
pip install twine wheel
Register at https://test.pypi.org/account/register/ (or real PIP),
confirm email. Then add to file ~/.pypirc
:
[testpypi]
username: MyUsername
Release
- Adjust version number in
VERSION.txt
- Document changes in
releases.txt
- Prepare build:
make release-prepare
- Upload to test PyPi:
make release-test
It might ask for password. Test that RKClient can be installed ie.
pip install -i https://test.pypi.org/simple/ RecordKeeper-Client==1.1.6 -v
- Use
make release
to upload to real PIP. Now client is available at: https://pypi.org/project/RecordKeeper-Client/ and can be installed with justpip install RecordKeeper-Client
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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f946280c32522bc3bf0b6777b1ec6f25d2f1bb83d3b2dd5e0655ac4eaba3afcd |
|
MD5 | cb34fd767940b4d84a0a04cabf9c43a0 |
|
BLAKE2b-256 | 2775a8d83d65f1c66736ef2ee5b976dbd03349f91584758f04ff2ef5914aac29 |
Hashes for RecordKeeper_Client-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bf689ca02aeac2d051756c1ebe346e6eeeb984d994c80b7088350c93b67d4d72 |
|
MD5 | 9c83e2f1d3cb75f39acd0adbdf25bffc |
|
BLAKE2b-256 | e058661b273957f1f6f7c21414004281693d7bd6136021f49ff63ac242664d49 |