Metadata-Version: 2.1
Name: brayns
Version: 0.7.0
Summary: Brayns python API
Home-page: https://github.com/BlueBrain/Brayns
Author: Daniel Nachbaur
Author-email: bbp-open-source@googlegroups.com
License: LGPLv3
Description: # Brayns
        
        The brayns package provides a python API to the brayns application.
        
        ## Documentation
        
        Brayns documentation is built and hosted on [readthedocs](https://readthedocs.org/).
        
        * [latest snapshot](http://brayns.readthedocs.org/en/latest/)
        * [latest release](http://brayns.readthedocs.org/en/stable/)
        
        ## Installation
        
        It is recommended that you use [`pip`](https://pip.pypa.io/en/stable/) to install
        `Brayns` into a [`virtualenv`](https://virtualenv.pypa.io/en/stable/). 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+https://github.com/BlueBrain/Brayns.git#subdirectory=python
        ```
        
        ### 3. From source
        
        Clone the repository and install it:
        
        ```
        (venv)$ git clone https://github.com/BlueBrain/Brayns.git
        (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
        
        ```python
        >>> from brayns import Client
        
        >>> brayns = Client('localhost:8200')
        >>> print(brayns)
        Brayns version 0.7.0.c52dd4b running on http://localhost:8200/
        ```
        
        ## Examples
        
        Please find some examples how to interact with Brayns from python on
        [`Read the Docs`](https://brayns.readthedocs.io/en/latest/examples.html).
        
Keywords: brayns,raytracing,bbp,BlueBrain
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
