Skip to main content

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


You can install this package from PyPI:

pip install brayns

Or from source:

git clone
cd Brayns/python
python sdist
pip install dist/* # Output in dist folder



Connect to a renderer backend instance:

import brayns

connector = brayns.Connector('localhost:5000')

with connector.connect() as 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.


As raw requests can be tedious, a higher level API is also provided.

models = brayns.get_models(instance)


A more complete documentation is available here.

Project details

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.1.tar.gz (62.6 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page