Substra CLI for interacting with substra-backend

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for guilhem.roch from gravatar.com guilhem.roch Avatar for jmorel from gravatar.com jmorel Avatar for samlesu from gravatar.com samlesu Avatar for SdgJlbl from gravatar.com SdgJlbl Avatar for ThibaultFy from gravatar.com ThibaultFy

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache 2.0
  • Author: Owkin, Inc.
  • Tags cli, substra
  • Requires: Python >=3.8
Classifiers
Report project as malware

Project description

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 is, please refer to the user documentation.

To discuss on Slack, please join the substra-general channel and the substra-help channel.

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.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page