CLI and SDK for interacting with Substra platform.
- Install
- Running the Substra platform locally
- Usage
- Documentation
- Examples
- Compatibility table
- Contributing
To install the command line interface and the python sdk, run the following command:
pip install substra
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.
Check out the setup guide.
Credentials are required for using this tool.
substra --help
import substra
client = substra.Client()
# enjoy...
- Documentation website
- Documentation repository
- Chat on Slack
Interacting with the Substra platform:
Implementing your assets in python (thanks to the substratools library)
- Objective base class
- Dataset base class
- Algo base class
- Composite algo base class
- Aggregate algo base class
These sets of versions have been tested for compatilibility:
substra | substra-chaincode | substra-backend | substra-tests | hlf-k8s | substra-frontend | substra-tools |
---|---|---|---|---|---|---|
0.4.0-alpha.3 |
0.0.8-alpha.6 |
0.0.12-alpha.13 |
0.2.0-alpha.1 |
0.0.11-alpha.1 |
0.0.16 |
|
0.4.0-alpha.4 |
0.0.8-alpha.9 |
0.0.12-alpha.20 |
0.2.0-alpha.2 |
0.0.11-alpha.1 |
0.0.16 |
|
0.4.0 |
0.0.8 |
0.0.12 |
0.2.0 |
0.0.11 |
0.0.16 |
|
0.5.0 |
0.0.8 |
0.0.14 |
0.3.0 |
0.0.12 |
0.0.16 |
0.5.0 |
0.6.0 |
0.0.10 |
0.0.19 |
0.4.0 |
0.0.12 |
0.0.17 |
0.5.0 |
0.7.0 |
0.0.11 |
0.1.2 helm chart 1.4.0 |
0.5.0 |
0.0.13 helm chart 3.0.1 |
0.0.19 helm chart 1.0.0-alpha.2 |
0.6.1 |
0.7.1 |
0.0.11 |
0.1.3 helm chart 1.5.1 |
0.5.0 |
0.0.13 helm chart 3.0.1 |
0.0.19 helm chart 1.0.0-alpha.2 |
0.6.1 |
0.8.0 |
0.2.0 |
0.1.6 helm chart 1.6.0 |
0.6.0 |
0.0.16 helm chart 5.1.0 |
0.0.20 helm chart 1.0.0-alpha.2 |
0.7.0 |
Adding entries to the compatibility table
- Please ensure that all the tests from
substra-tests
pass
$ cd substra-tests
$ make test
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, sdk and schemas documentation, the python
version
must be 3.7. Run the following command:
make doc
Documentation will be available in the references/ directory.
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