Skip to main content

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

Metadata

Release files for nexus-sdk 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nexus-sdk 0.3.2
File Size Uploaded Provenance
nexus-sdk-0.3.2.tar.gz 369.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for nexus-sdk 0.3.2
File Interpreter ABI Platform
nexus_sdk-0.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 415.0 kB

Release files / nexus-sdk-0.3.2.tar.gz

Download URL nexus-sdk-0.3.2.tar.gz
Size 369.9 kB
Tags Source
SHA-256 checksum
How to use checksums
cd5668a062283410c5ff57a68c218440df607da84e0a813a8c9390611f7212b3
BLAKE2b-256 checksum
How to use checksums
2a2170acfcbbffa4908bcfbad23d66be626a0814e80c35c6a725d2509be0206f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

Release files / nexus_sdk-0.3.2-py3-none-any.whl

Download URL nexus_sdk-0.3.2-py3-none-any.whl
Size 45.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5dd288515a3949035803511a195151c252243d3b097e1586d9efd28a227739e2
BLAKE2b-256 checksum
How to use checksums
1d0c354868778a580be31151dbb3ab6b309cc790523ba73021264dff1e789a72
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.6.8

Security for nexus-sdk 0.3.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page