TabPy Installation Instructions

These instructions explain how to install and start up TabPy Server.

• TabPy Installation
• Starting TabPy

TabPy Installation

Prerequisites

• TabPy only supports Python versions 3.7, 3.8, 3.9, and 3.10
• TabPy 2.7.0 added support for data streaming via Apache Arrow Flight (pyarrow). When using TabPy >= 2.7.0, we recommend using a Python 64-bit installer to avoid incompatibility issues related to pyarrow.

Installation

To install TabPy on to an environment pip needs to be installed and updated first:

python -m pip install --upgrade pip

Now TabPy can be install as a package:

pip install tabpy

Starting TabPy

To start TabPy with default settings run the following command:

tabpy

To run TabPy with custom settings create config file with parameters explained in TabPy Server Configuration Instructions and specify it in command line:

tabpy --config=path/to/my/config/file.conf

It is highly recommended to use Python virtual environment for running TabPy. Check the Running TabPy in Python Virtual Environment page for more details.

Starting a Local TabPy Project

To create a version of TabPy that incorporates locally-made changes, use pip to create a package from your local TabPy project and install it within that directory (preferably a virtual environment):

pip install -e .

Then start TabPy just like it was mentioned earlier

tabpy