Brayns Python API
Project description
Brayns Python API
A client for Brayns based on a websocket client to provide remote control on a running braynsService instance.
Table of Contents
Installation
You can install this package from PyPI:
pip install brayns
Or from source:
git clone https://github.com/BlueBrain/Brayns.git
cd Brayns/python
python setup.py sdist
pip install dist/* # Output in dist folder
Usage
Connection
Connect to a renderer backend instance:
import brayns
connector = brayns.Connector('localhost:5000')
with connector.connect() as instance:
print(brayns.get_version(instance))
Raw requests
Raw JSON-RPC requests can be sent using the instance:
result = instance.request('schema', {'endpoint': 'get-version'})
It will throw a brayns.RequestError if an error occurs.
API
As raw requests can be tedious, a higher level API is also provided.
models = brayns.get_models(instance)
Documentation
A more complete documentation is available here.
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
brayns-3.7.0.tar.gz
(62.6 kB
view hashes)
