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.4.1.tar.gz
(61.7 kB
view details)
File details
Details for the file brayns-3.4.1.tar.gz.
File metadata
- Download URL: brayns-3.4.1.tar.gz
- Upload date:
- Size: 61.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.18
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5e88e0b702479119bd1e00a8a532e25dd8c1a398d50599cd975a043965944a83 |
|
| MD5 | 67e049beb905598eaba1f63808cb54ae |
|
| BLAKE2b-256 | 23c9dbec007142221ae239a9f1796fff18f963824c5eb2e387fc435f89fd730b |
