max-bytes/omnikeeper-client-python

omnikeeper-client-python

Required omnikeeper version: 30.5.0

Usage

prepare your environment

This setup was tested and developed using VSCode

# ensure no local stuff is added
unset PYTHONPATH

python3 -m venv .venv
. .venv/bin/activate
pip3 install --upgrade pip

# install project requirements
pip3 install -r requirements.txt

# install additional dev requirements (used to develop)
pip3 install -r requirements-dev.txt

get familiar

have a look at our examples

Build and Package

Work in Progress

build library

rm -rf build
python setup.py bdist_wheel

upload to PyPi

twine upload dist/omnikeeper_client-2.0.0-py3-none-any.whl

https://packaging.python.org/en/latest/tutorials/packaging-projects/#generating-distribution-archives

python3 -m pip install --upgrade build

use from PyPi

Note: this project depends on oauthlib-sessionhandler, which is not available on PyPI. One place where you can find it is at: https://github.com/MHx-Operations/oauthlib-sessionhandler.

One way to install oauthlib-sessionhandler is to run the following command:

python -m pip install 'git+https://github.com/MHx-Operations/oauthlib-sessionhandler.git@2de98b3119aa2fa73e5ac8a3ca384573dfaa0f36'