Skip to main content

Python tools to submit functions on the Substra platform

Project description



Substra is an open source federated learning (FL) software. This specific repository, substra-tools, is a Python package defining base classes for Dataset (data opener script) and wrappers to execute functions submitted on the platform.

This repository also contains a Dockerfile to execute the user Python scripts on the Substra platform. This is currently needed to easily have substratools package available inside the Docker image without using a pypi server.

Getting started

To install the substratools Python package, run the following command:

pip install substratools

Pull the substra-tools Docker image

docker pull


Clone the repository:

Build the Docker image from source

docker build -f Dockerfile .


To setup the project in development mode, run:

pip install -e ".[test]"

To run all tests, use the following command:

python test

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

substratools-0.21.1.tar.gz (21.6 kB view hashes)

Uploaded source

Built Distribution

substratools-0.21.1-py3-none-any.whl (27.9 kB view hashes)

Uploaded py3

Supported by

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