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.
2 maintainers
Metadata
2 maintainers
Release files for brayns 3.10.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| brayns-3.10.1.tar.gz | 63.1 kB | Details |
Release files / brayns-3.10.1.tar.gz
| Download URL | brayns-3.10.1.tar.gz |
|---|---|
| Size | 63.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71756fc956520ea7cf6bef561628c7a66625fa84608b30acd4eab6b238ad1c04
|
|
BLAKE2b-256 checksum How to use checksums |
53f8f189ba6c3074485e58c244d5e9afac6fd64b4dcc8c304c41adaa563d8365
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
