No longer maintained, as I have moved to using Home Assistant.
A Python client for controlling Shinobi (an open-source video management solution).
This package contains an (very incomplete) set of tools for interacting with Shinobi using Python.
This library tries to use the (rather unique) documented API but it also uses undocumented endpoints (which may not be stable).
Install from PyPi:
pip install shinobi-client
Install with ability to start a Shinobi installation:
pip install shinobi-client[shinobi-controller]
Install with CLI:
pip install shinobi-client[cli]
Warning: methods are generally not thread safe.
Start with creating the client for a particular Shinobi installation:
from shinobi_client import ShinobiClient
shinobi_client = ShinobiClient(host, port, super_user_token=super_user_token)
(super_user_token
is optional and only required for some operations.)
user = shinobi_client.user.get(email)
# Get user details using the user's password (does not require super user token)
user = shinobi_client.user.create(email, password)
users = shinobi_client.user.get_all()
user = shinobi_client.user.create(email, password)
modified = shinobi_client.user.modify(email, password=new_password)
deleted = shinobi_client.user.delete(email)
api_key = shinobi_client.api_key.get(email, password)
# Setting monitors (camera setups) for the user with the given email address
monitor_orm = shinobi_client.monitor(email, password)
monitors = monitor_orm.get_all()
monitor = monitor_orm.get(monitor_id)
monitor = monitor_orm.create(monitor_id, configuration)
modified = monitor_orm.modify(monitor_id, configuration)
deleted = monitor_orm.delete(monitor_id)
Starts/Stops a temporary containerised installation of Shinboi. Written for the purpose of testing but it is also installable as an extra. Requires Docker.
from shinobi_client import start_shinobi
with start_shinobi() as shinobi_client:
print(shinobi_client.url)
# Do things with a temporary Shinobi installation
or
from shinobi_client import ShinobiController
controller = ShinobiController()
shinobi_client = controller.start()
print(shinobi_client.url)
# Do things with a temporary Shinobi installation
controller.stop()
A basic auto-generated CLI is available if the package is installed with the cli
extra:
PYTHONPATH=. python shinobi_client/user.py \
--host=HOST --port=PORT --super_user_token=SUPER_USER_TOKEN \
get user@example.com
e.g.
$ PYTHONPATH=. python shinobi_client/cli.py \
--host='0.0.0.0' --port=50694 --super_user_token='26dd3352-73c4-4bbd-8b09-17f2aacbd7b9' \
create 'user@example.com' 'password123'
Install with dev-dependencies:
poetry install --no-root --extras "shinobi-controller cli"
Run tests with:
python -m unittest discover -v -s shinobi/tests
GPL v3.0. Copyright 2020 Colin Nolan.
I am not affiliated to the development of Shinobi project in any way.
This work is in no way related to the company that I work for.