Installation

The latest stable version of taipy-rest is available through pip:

bash

pip install taipy-rest

Development version

You can install the development version of taipy-rest with pip and git via the taipy repository:

bash

pip install git+https://[email protected]/Avaiga/taipy

This command installs the development version of taipy package in the Python environment with all its dependencies, including the taipy-rest package.

If you need the source code for taipy-rest on your system so you can see how things are done or maybe participate in the improvement of the packages, you can clone the GitHub repository:

bash

git clone https://github.com/Avaiga/taipy.git

This creates the 'taipy' directory holding all the package's source code, and the 'taipy-rest' source code is in the 'taipy/rest' directory.

Configuration

Before running, we need to define some variables. Taipy REST APIs depend on pre-configuration of taipy config objects, i.e, is mandatory to define all configuration of DataNodes, Tasks, Sequences, etc. The file containing this configuration needs to be passed to the application at runtime. The following variable needs to be defined:

TAIPY_SETUP_FILE: the path to the file containing all of taipy object configuration

If using Docker, the folder containing the file needs to be mapped as a volume for it to be accessible to the application.

Running

To run taipy-rest, you need to install the required development packages. We recommend using Pipenv to create a virtual environment and install the development packages.

bash

pip install pipenv
pipenv install --dev

To run the application you can either run locally with:

bash

flask run

or it can be run inside Docker with:

bash

docker-compose up

You can also run with a Gunicorn or wsgi server.

Running with Gunicorn

This project provide a simple wsgi entry point to run gunicorn or uwsgi for example.

For gunicorn you only need to run the following commands

bash

pip install gunicorn

gunicorn myapi.wsgi:app

And that's it! Gunicorn is running on port 8000.

If you chose gunicorn as your wsgi server, the proper commands should be in your docker-compose file.

Running with uwsgi

Pretty much the same as gunicorn here

bash

pip install uwsgi
uwsgi --http 127.0.0.1:5000 --module myapi.wsgi:app

And that's it! Uwsgi is running on port 5000.

If you chose uwsgi as your wsgi server, the proper commands should be in your docker-compose file.

Deploying on Heroku

Make sure you have a working Docker installation (e.g. docker ps) and that you’re logged in to Heroku (heroku login).

bash

heroku container:login

Create a heroku app

bash

heroku create

Build the image and push to Container Registry:

bash

heroku container:push web

Then release the image:

bash

heroku container:release web

You can now access taipy-rest on the URL that was returned on the heroku create command.

Documentation

All the API Documentation can be found, after running the application in the following URL:

/redoc-ui ReDoc UI configured to hit OpenAPI yaml file
/openapi.yml return OpenAPI specification file in yaml format