CLI and SDK for interacting with Substra platform.
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.
substra --help
import substra
client = substra.Client()
# enjoy...
Interacting with the Substra platform:
Implementing your assets in python:
Learning about the Substra platform:
To setup the project in development mode, run:
pip install -e .[test]
To run all tests, use the following command:
python setup.py test
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+ > docs/sdk.md
Documentation will be available in docs/ directory.
rm -rf dist/*
python3 setup.py sdist bdist_wheel
twine upload dist/* --repository-url https://substra-pypi.owkin.com/ --verbose