substra 0.40.0

Substra CLI for interacting with substra-backend

Substra is a python library and a command line interface to interact with the Substra platform. For more information on what is substra and how to use it, please refer to the user documentation.

Join the discussion on Slack!

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.8. Run the following command:

make doc

Documentation will be available in the references/ directory.