brayns

Name	brayns JSON
Version	3.6.0 JSON
	download
home_page	https://github.com/BlueBrain/Brayns
Summary	Brayns Python API
upload_time	2024-02-22 15:41:49
maintainer
docs_url	None
author	Blue Brain Project
requires_python	>=3.9
license	LGPLv3
keywords	brayns raytracing bbp bluebrain
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Brayns Python API

> A client for [Brayns](../README.md) based on a websocket client to provide
remote control on a running braynsService instance.

# Table of Contents

* [Installation](#installation)
* [Usage](#usage)
    * [Connection](#connection)
    * [Raw requests](#rawrequests)
    * [API](#api)
* [Documentation](#documentation)

## Installation
---------------

You can install this package from [PyPI](https://pypi.org/):

```bash
pip install brayns
```

Or from source:

```bash
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:

```py
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:

```py
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.

```py
models = brayns.get_models(instance)
```

## Documentation
-----------------

A more complete documentation is available
[here](https://brayns.readthedocs.io/en/latest/).



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/BlueBrain/Brayns",
    "name": "brayns",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "brayns,raytracing,bbp,BlueBrain",
    "author": "Blue Brain Project",
    "author_email": "bbp-open-source@googlegroups.com",
    "download_url": "https://files.pythonhosted.org/packages/be/11/2f40743a52421dfa1a80205cba2798de40ef4771f6905685fed1c3de4e8a/brayns-3.6.0.tar.gz",
    "platform": null,
    "description": "# Brayns Python API\n\n> A client for [Brayns](../README.md) based on a websocket client to provide\nremote control on a running braynsService instance.\n\n# Table of Contents\n\n* [Installation](#installation)\n* [Usage](#usage)\n    * [Connection](#connection)\n    * [Raw requests](#rawrequests)\n    * [API](#api)\n* [Documentation](#documentation)\n\n## Installation\n---------------\n\nYou can install this package from [PyPI](https://pypi.org/):\n\n```bash\npip install brayns\n```\n\nOr from source:\n\n```bash\ngit clone https://github.com/BlueBrain/Brayns.git\ncd Brayns/python\npython setup.py sdist\npip install dist/* # Output in dist folder\n```\n\n## Usage\n--------\n\n### Connection\n\nConnect to a renderer backend instance:\n\n```py\nimport brayns\n\nconnector = brayns.Connector('localhost:5000')\n\nwith connector.connect() as instance:\n    print(brayns.get_version(instance))\n```\n\n### Raw requests\n\nRaw JSON-RPC requests can be sent using the instance:\n\n```py\nresult = instance.request('schema', {'endpoint': 'get-version'})\n```\n\nIt will throw a brayns.RequestError if an error occurs.\n\n### API\n\nAs raw requests can be tedious, a higher level API is also provided.\n\n```py\nmodels = brayns.get_models(instance)\n```\n\n## Documentation\n-----------------\n\nA more complete documentation is available\n[here](https://brayns.readthedocs.io/en/latest/).\n\n\n",
    "bugtrack_url": null,
    "license": "LGPLv3",
    "summary": "Brayns Python API",
    "version": "3.6.0",
    "project_urls": {
        "Download": "https://github.com/BlueBrain/Brayns",
        "Homepage": "https://github.com/BlueBrain/Brayns",
        "Source": "https://github.com/BlueBrain/Brayns",
        "Tracker": "https://bbpteam.epfl.ch/project/issues/projects/BRAYNS/issues"
    },
    "split_keywords": [
        "brayns",
        "raytracing",
        "bbp",
        "bluebrain"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "be112f40743a52421dfa1a80205cba2798de40ef4771f6905685fed1c3de4e8a",
                "md5": "e6833fc68d0d73a23a1fda2b5b535eb7",
                "sha256": "7f9d5ef4707f7cc1b379dc02cca53dc58620a821fe94221668e31765f2a87661"
            },
            "downloads": -1,
            "filename": "brayns-3.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e6833fc68d0d73a23a1fda2b5b535eb7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 62329,
            "upload_time": "2024-02-22T15:41:49",
            "upload_time_iso_8601": "2024-02-22T15:41:49.875915Z",
            "url": "https://files.pythonhosted.org/packages/be/11/2f40743a52421dfa1a80205cba2798de40ef4771f6905685fed1c3de4e8a/brayns-3.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-22 15:41:49",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "BlueBrain",
    "github_project": "Brayns",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "brayns"
}