build.md

Building ff-python-server-sdk

This document shows the instructions on how to build and contribute to the SDK.

Requirements

Python >= 3.7 or newer (python --version)
pip

For Mac users if you don't already have pyenv or something similar installed for managing python version

Install Dependancies

python -m pip install --upgrade pip
python -m pip install nose tornado flake8 pytest
python -m pip install -r requirements_dev.txt

Build the SDK

Some make targets have been provided to build and package the SDK

make dist

Executing tests

pytest is used to run the SDK unit tests.

pytest --junitxml=junit.xml

Linting and Formating

To ensure the projecti is correctly formatted you can use the following commands

make lint fmt