Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Nexus JS Banner

Nexus Python SDK

Python SDK for Blue Brain Nexus v1.

Status | Getting Started | Upgrade | Releases | Contributing


Status

Beta.

Getting Started

Usage

import nexussdk as nexus

nexus.config.set_environment(DEPLOYMENT)
nexus.config.set_token(TOKEN)

nexus.permissions.fetch()

More examples in the folder notebooks and tests.

Documentation: https://bluebrain.github.io/nexus-python-sdk/.

Installation

pip install nexus-sdk

Development version

pip install git+https://github.com/BlueBrain/nexus-python-sdk

Development mode

git clone https://github.com/bluebrain/nexus-python-sdk
pip install --editable nexus-python-sdk

Requirements

Upgrade

pip install --upgrade nexus-sdk

Releases

Versions and their notable changes are listed in the releases section.

Contributing

Styling

Follow PEP 20, PEP 8, and PEP 257, at least.

Documentation

The documentation is auto-generated with Sphinx. To install it:

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

cd docs-source/sphinx
make html

Deploy

cp -R build/html/ ../../docs/

Releasing

Setup

pip install --upgrade pip setuptools wheel twine

Tagging

git checkout master
git pull upstream master
git tag -a v<x>.<y>.<z> HEAD
git push upstream v<x>.<y>.<z>

Building

python setup.py sdist bdist_wheel

Upload

twine upload dist/*

Cleaning

rm -R build dist *.egg-info

Funding & Acknowledgment

This study was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government’s ETH Board of the Swiss Federal Institutes of Technology.

Copyright © 2015-2021 Blue Brain Project/EPFL