Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

Brayns python API

Project description


The brayns package provides a python API to the brayns application.


Brayns documentation is built and hosted on readthedocs.


It is recommended that you use pip to install Brayns into a virtualenv. The following assumes a virtualenv named venv has been set up and activated. We will see three ways to install Brayns

1. From the Python Package Index

(venv)$ pip install brayns

2. From git repository

(venv)$ pip install git+

3. From source

Clone the repository and install it:

(venv)$ git clone
(venv)$ pip install -e ./Brayns/python

This installs Brayns into your virtualenv in "editable" mode. That means changes made to the source code are seen by the installation. To install in read-only mode, omit the -e.

Connect to running Brayns instance

>>> from brayns import Client

>>> brayns = Client('localhost:8200')
>>> print(brayns)
Brayns version 0.7.0.c52dd4b running on http://localhost:8200/


Please find some examples how to interact with Brayns from python on Read the Docs.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for brayns, version 0.7.0
Filename, size File type Python version Upload date Hashes
Filename, size brayns-0.7.0.tar.gz (12.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page