Metadata-Version: 2.1
Name: nexus-sdk
Version: 0.3.0
Summary: Python SDK for Blue Brain Nexus v1.
Home-page: https://github.com/BlueBrain/nexus-python-sdk
License: Apache License, Version 2.0
Description: [Status](#status) |
        [Getting Started](#getting-started) |
        [Upgrade](#upgrade) |
        [Releases](#releases) |
        [Contributing](#contributing)
        
        # Nexus Python SDK
        
        Python SDK for [Blue Brain Nexus](https://github.com/BlueBrain/nexus) v1.
        
        ---
        
        ## Status
        
        Beta.
        
        ## Getting Started
        
        ### Usage
        
        ````python
        import nexussdk as nexus
        
        nexus.config.set_environment(DEPLOYMENT)
        nexus.config.set_token(TOKEN)
        
        nexus.permissions.fetch()
        ````
        
        More examples in the folder [notebooks](./notebooks) and [tests](./tests).
        
        Documentation: https://bluebrain.github.io/nexus-python-sdk/.
        
        ### Installation
        
        ```bash
        pip install nexus-sdk
        ```
        
        **Development version**
        
        ```bash
        pip install git+https://github.com/BlueBrain/nexus-python-sdk
        ```
        
        **Development mode**
        
        ```bash
        git clone https://github.com/bluebrain/nexus-python-sdk
        pip install --editable nexus-python-sdk
        ```
        
        **Requirements**
        
        - [requests](http://docs.python-requests.org)
        
        ## Upgrade
        
        ```bash
        pip install --upgrade nexus-sdk
        ```
        
        ## Releases
        
        Versions and their notable changes are listed in the [releases section](
        https://github.com/BlueBrain/nexus-python-sdk/releases/).
        
        ## Contributing
        
        ### Styling
        
        Follow [PEP 20](https://www.python.org/dev/peps/pep-0020/),
        [PEP 8](https://www.python.org/dev/peps/pep-0008/), and
        [PEP 257](https://www.python.org/dev/peps/pep-0257/), at least.
        
        ### Documentation
        
        The documentation is auto-generated with [Sphinx](http://www.sphinx-doc.org).
        To install it:
        
        ```bash
        pip install nexus-sdk[doc]
        ```
        
        **Update**
        
        To add a new module to the API Reference, add the corresponding section in the
        files `admin-reference.rst`, `kg-reference.rst`, or `iam-reference.rst` which 
        are in the directory `docs-sources/sphix/source/`.
        
        **Generate**
        
        ```bash
        cd docs-source/sphinx
        make html
        ```
        
        **Deploy**
        
        ```bash
        cp -R build/html/ ../../docs/
        ```
        
Keywords: nexus sdk
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Information Technology
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Natural Language :: English
Requires-Python: >=3.5
Description-Content-Type: text/markdown
Provides-Extra: doc
Provides-Extra: test
