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

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.

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.10.1.tar.gz (63.1 kB view details)

Uploaded Source

File details

Details for the file brayns-3.10.1.tar.gz.

File metadata

  • Download URL: brayns-3.10.1.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

Hashes for brayns-3.10.1.tar.gz
Algorithm Hash digest
SHA256 71756fc956520ea7cf6bef561628c7a66625fa84608b30acd4eab6b238ad1c04
MD5 e08d6d25e2a596915c984fa198bad3c4
BLAKE2b-256 53f8f189ba6c3074485e58c244d5e9afac6fd64b4dcc8c304c41adaa563d8365

See more details on using hashes here.

Supported by

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