Python SDK for Blue Brain Nexus v1.
Project description
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
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
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nexus_sdk-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bfa20ca4aeb0f5f700cc7404cd6d48e2cd9f0278a9187cb0f8b26d1476ad209 |
|
MD5 | 3c0d92e98a685c317b4e22c00fe5c152 |
|
BLAKE2b-256 | 69f1b2aa1751bf97ff834871b6ccc89e7637bd1ff1e434a39ebb6e398b270cb6 |