Substra CLI for interacting with substra-backend
Project description
CLI and SDK for interacting with Substra platform.
Table of contents
- Table of contents
- Install
- Running the Substra platform locally
- Usage
- Documentation
- Examples
- Contributing
Install
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.
Running the Substra platform locally
Check out the open source setup guide or the close source setup guide
Before installing the different components of the platform, please have a look to the compatibility table
Usage
Credentials are required for using this tool.
CLI
substra --help
SDK
import substra
client = substra.Client()
# enjoy...
Open Source Documentation
- Documentation website
- Documentation repository
- Chat on Slack
Interacting with the Substra platform:
Implementing your assets in python (thanks to the substratools library)
Examples
Contributing
Setup
To setup the project in development mode, run:
pip install -e ".[dev]"
To run all tests, use the following command:
python setup.py test
Code formatting
You can opt into auto-formatting of code on pre-commit using Black.
This relies on hooks managed by pre-commit, which you can set up as follows.
Install pre-commit, then run:
pre-commit install
Documentation
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.
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
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.
Source Distribution
Built Distribution
File details
Details for the file substra-0.29.2.tar.gz.
File metadata
- Download URL: substra-0.29.2.tar.gz
- Upload date:
- Size: 81.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fe8b5aec65d5fb2ee2bd94e1bec67fb8d48c9f8e62884500dc5e33f9c92e9709 |
|
| MD5 | 06c47dde63721f79eef544b592a36e8a |
|
| BLAKE2b-256 | 040655096793082f60d01e8e3497b5a72741d052fd27eb2f7922d779b6852fcd |
File details
Details for the file substra-0.29.2-py3-none-any.whl.
File metadata
- Download URL: substra-0.29.2-py3-none-any.whl
- Upload date:
- Size: 78.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.9.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a873dcfbdff736fc53862b00093cee8da63bae0bae027a73903bd4551a764c63 |
|
| MD5 | 82d9044b737fff55636af3095c6b0c48 |
|
| BLAKE2b-256 | 116bb462e8e1da4acdc20380f1263c2b7953aec713aec11a3292dfb8ba476867 |
