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.10.0.tar.gz
(63.1 kB
view details)
File details
Details for the file brayns-3.10.0.tar.gz.
File metadata
- Download URL: brayns-3.10.0.tar.gz
- Upload date:
- Size: 63.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6bf9406f4901b2bd11802cbe4967ab027dfc1910025cd6de1cd244d695daa1cb |
|
| MD5 | 925d0dfd7bb10172bdf123b4848575a2 |
|
| BLAKE2b-256 | 3bbb67b9f9691dcc971776134be1e42554dbaaa928260481e139ab6a21e7fbe0 |
