Skip to content
This repository has been archived by the owner on Feb 15, 2024. It is now read-only.

Latest commit

 

History

History
128 lines (92 loc) · 3.92 KB

INSTALLATION.md

File metadata and controls

128 lines (92 loc) · 3.92 KB
Raw

Installation

There are different ways to install Taipy GUI, depending on how you plan to use it:

Taipy GUI needs your system to have Python 3.8 or above installed.

Installing the latest release

The easiest way to install Taipy GUI is using pip

Run the command:

pip install taipy-gui

Installing the development version

The development version of Taipy GUI is updated daily with changes from the Taipy R&D and external contributors that we praise for their input.

You should also install this version if you want to contribute to the development of Taipy GUI. Here are the steps to follow:

1 - Clone the repository

Clone the repository using the following command:

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

2 - Install Node.js

Taipy GUI has some code dealing with the client side of the web applications. This code is written in TypeScript, relies on React components, and is packaged into a JavaScript bundle that is sent to browsers when they connect to all Taipy GUI applications.

This bundle needs to be built before being usable by Taipy GUI.

First you need to install Node.js on your system.

Select the "Recommended For Most Users" version, and follow the instructions for your system.

Select "Automatically install the necessary tools" when asked.

3 - Build the JavaScript bundle

Open a new terminal and run the following commands:

  • Install the DOM dependencies
cd gui
cd dom
npm i
  • Install the web app dependencies
cd ..
npm i --omit=optional
  • Build the web app
npm run build

After a few minutes, this creates the directory src/taipy/gui/webapp in the root directory of the repository where the front-end code for Taipy GUI is split into a set of JavaScript bundles.

4 - Install the package as editable

In a terminal, at the root of the repository, run:

pip install -e . --user

This should install the dev version of Taipy GUI as editable. You are now ready to use it.

Debugging the JavaScript bundle

If you plan to modify the front-end code and need to debug the TypeScript code, you must use the following:

$ npm run build:dev

instead of the standard build option.

This will preserve the debugging symbols, and you will be able to navigate in the TypeScript code from your debugger.

Note: Web application location

When you are developing front-end code for the Taipy GUI package, it may be cumbersome to have to install the package over and over when you know that all that has changed is the JavaScript bundle that makes the Taipy web app.

By default, the Taipy GUI application searches for the front-end code in the [taipy-gui-package-dir]/taipy/src/gui/webapp directory.
You can, however, set the environment variable TAIPY_GUI_WEBAPP_PATH to the location of your choice, and Taipy GUI will look for the web app in that directory.
If you set this variable to the location where you build the web app repeatedly, you will no longer have to reinstall Taipy GUI before you try your code again.

Running the tests

To run the tests on the package, you need to create a virtual environment and install the development packages:

Here are the commands to issue:

pipenv install --dev
pipenv run pytest