nexussdk 0.3.2
Status |
Getting Started |
Upgrade |
Releases |
Contributing
Nexus Python SDK
Python SDK for Blue Brain Nexus v1.
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
requests
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
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
There are no reviews.