Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 810 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 810 Bytes
Raw

Contributing Guide

Environment Setup

TabPy suggests using Pipenv to configure and manage your development environment and provides facilities to enable this out of the box. To start, clone the source code and from the project root run:

pipenv install --dev

This will create a dedicated virtual environment containing all of the required packages.

Starting the Server

From the project root, activate the virtual environment you created above via:

pipenv shell

Thereafter, simply navigate to tabpy-server/tabpy-server and run:

python tabpy.py

Testing Your Changes

After making any changes to either the client or the server you can run the regression test suite from the top level directory as follows:

python runtests.py