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

Uploaded Source

File details

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

File metadata

  • Download URL: brayns-3.8.1.tar.gz
  • Upload date:
  • Size: 62.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.9.19

File hashes

Hashes for brayns-3.8.1.tar.gz
Algorithm Hash digest
SHA256 84812072fcad8e6f1f6ab2e034c28a3336118e6bebd70f51e6a353665ffaf95d
MD5 f1b574c55428177bcf62e784e0c66b21
BLAKE2b-256 5229cf9de55d57eae7306ed4ca60be1d2aa18d23baebe546f65bef6e7e4f839e

See more details on using hashes here.

Provenance

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