Substra CLI for interacting with substra-backend
Project description
CLI and SDK for interacting with Substra platform.
Table of contents
Install
To install the command line interface and the python sdk, run the following command:
pip install .
To enable Bash completion, you need to put into your .bashrc:
eval "$(_SUBSTRA_COMPLETE=source substra)"
For zsh users add this to your .zshrc:
eval "$(_SUBSTRA_COMPLETE=source_zsh substra)"
From this point onwards, substra command line interface will have autocompletion enabled.
See the local install guide if you need to run a full instance of the Substra platform locally.
Usage
Credentials are required for using this tool.
CLI
substra --help
SDK
import substra
client = substra.Client()
# enjoy...
Documentation
Interacting with the Substra platform:
Implementing your assets in python:
Learning about the Substra platform:
Examples
Contributing
Setup
To setup the project in development mode, run:
pip install -e .[test]
To run all tests, use the following command:
python setup.py test
Documentation
To generate the command line interface documentation, run the following command:
python bin/generate_cli_documentation.py
Use the following command to generate the python sdk documentation:
pydocmd simple substra.sdk+ substra.sdk.Client+ > references/sdk.md
Documentation will be available in docs/ directory.
Deploy
Deployment to pypi.org should be automatic thanks to Travis but if you need to do it manually, here is what you need to do:
rm -rf dist/*
python3 setup.py sdist bdist_wheel
twine upload dist/* --verbose
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.