From 1cc27da11316e17634998604481a28267ec7eb47 Mon Sep 17 00:00:00 2001 From: erikfTW Date: Wed, 6 Sep 2023 13:39:23 +0200 Subject: [PATCH] Getting started - Install Taipy --- docs/installation.md | 74 +++++++++++++++++++++++++------------- docs/manuals/about.md | 84 ------------------------------------------- mkdocs.yml_template | 2 +- 3 files changed, 50 insertions(+), 110 deletions(-) delete mode 100644 docs/manuals/about.md diff --git a/docs/installation.md b/docs/installation.md index 5f3d93228..ebb1b7c25 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -3,55 +3,79 @@ hide: - navigation --- -# Installation +# Install Taipy + +Welcome to the installation section of the Taipy web application builder! This section will guide you through the seamless and straightforward process of setting up and deploying your own powerful web applications. ## Prerequisite -To run Taipy, Python (version 3.8 or above) and [pip](https://pip.pypa.io) are required. If you don't have `pip` installed, this [Python installation guide](http://docs.python-guide.org/en/latest/starting/installation/) can guide you through the process, or you can follow the [official installation page](https://pip.pypa.io/en/latest/installation/) of `pip`. +Before installing Taipy, ensure you have Python (version 3.8 or above) and [pip](https://pip.pypa.io) installed on your system. If you don't have pip installed, you can follow these steps to install it: + +1. **[Python Installation Guide](http://docs.python-guide.org/en/latest/starting/installation/)**: Follow the installation guide to set up Python on your system. + After the installation, you can open the Command Prompt and type `python --version` to check the installed Python version. + +2. **[Installing pip](https://pip.pypa.io/en/latest/installation/)**: Pip is included by default if you use Python 3.4 or later. Otherwise, you can follow the official + installation page of pip to install it. To verify the installation, type `pip --version` or `pip3 --version`. + +Alternatively, if you are using a Conda environment, you can install pip using the following command: -You can also install `pip` in a [Conda](https://docs.conda.io/projects/conda/en/latest/index.html) environment by using the following command: ``` console $ conda install pip ``` -## Stable release +To install Taipy, you have several options depending on your needs and preferences. -To install Taipy, run this command in your terminal: +## Installing Taipy - Stable release + +The preferred method to install Taipy is by using **pip**. Open your terminal or command prompt and run the following command: ``` console $ pip install taipy ``` -!!! info "This is the preferred method to install Taipy, as it will always install the most recent stable release." +This command will download and install the most recent stable release of Taipy. -### Installing Taipy in a Conda environment +## Installing Taipy in a Conda Environment -Taipy can also be installed and used in a `Conda` environment, run this command in your terminal: -``` console -$ conda create -n env-name -$ conda activate env-name -$ pip install taipy -``` +Conda is an open-source package management system and environment management system that runs on Windows, macOS, and Linux. -## From source +If you prefer to work within a [Conda](https://docs.conda.io/projects/conda/en/latest/index.html) environment, follow these steps: -The source for Taipy can be downloaded from -the [Github repo](https://github.com/Avaiga/taipy). +1. Create a new **Conda** environment (replace **env-name** with your desired environment name): + ``` console + $ conda create -n env-name + ``` +2. Activate the newly created environment: + ``` console + $ conda activate env-name + ``` +3. Install Taipy within the Conda environment using pip: + ``` console + $ pip install taipy + ``` -You can either clone the public repository: +## Installing Taipy from Source -``` console -$ git clone git://github.com/avaiga/taipy -``` +If you want to work with the latest development version or contribute to the project, you can install Taipy from the source code. -Or download the [tarball](https://github.com/Avaiga/taipy/tarball/main): +- Clone the public repository from GitHub (you'll need Git installed for this method): + ``` console + $ git clone git://github.com/avaiga/taipy + ``` -``` console -$ curl -OJL https://github.com/avaiga/taipy/tarball/main -``` +Or, + +- Download the tarball directly from GitHub: + ``` console + $ curl -OJL https://github.com/avaiga/taipy/tarball/main + ``` -Once you have a copy of the source, you can install it with: +Once you have the source code, navigate to the directory containing the Taipy source code and run the following command: ``` console $ pip install . ``` + +This will install Taipy from the source code on your system. + +!!! info "The commands mentioned above are for Unix-like systems (Linux, macOS), and you may need to adjust them slightly if you are using a different operating system such as Windows." diff --git a/docs/manuals/about.md b/docs/manuals/about.md deleted file mode 100644 index 1b1478062..000000000 --- a/docs/manuals/about.md +++ /dev/null @@ -1,84 +0,0 @@ -# About Taipy's User Manual - -This User Manual covers all the topics and concepts that you can find in Taipy. -For each topic, we are trying to provide as many examples as possible so that -you as a Taipy user can perform a specific task. - -If you are just starting with Taipy, you may want to look at the -[Getting Started document](../getting_started/installation.md) -in order to see a step-by-step example of a complete Taipy application. - -!!! important "Supported Python versions" - - Taipy requires **Python 3.8** or newer. - -## Quick Access - -These topics are the most visited ones, we thought you’d like to have a glance at them! - -
-
- -
- - -

Visual elements

-
-

- Browse dozens of Taipy GUI controls to build your UI -

- Read more - -
-
- -
- - -

Charts

-
-

- An important component of Taipy GUI with almost infinite possibilities right at your fingertips. -

- Read more - -
-
- -## Graphical User Interface (GUI) - `taipy.gui` - -The `taipy.gui^` package allows you to design an effective Graphic User Interface. -It provides many interactive widgets, controls, and presentative elements to enhance the -user’s experience. - -[:material-arrow-right: GUI User Manual](gui/index.md) - -## Taipy Core - `taipy.core` - -The `taipy.core^` package is a Python library designed to build powerful and customized data-driven back-end -applications. -It provides the necessary tools to help Python developers transform their algorithms into a complete -back-end application. - -Taipy Core brings algorithm management to another level: algorithms are now connected to the end-user through -user-defined scenarios, interactive data, smart job orchestration, etc. - - -[:material-arrow-right: Definition of Taipy Core concepts](core/concepts/index.md), - -[:material-arrow-right: Documentation on Taipy Core configuration](core/config/index.md), - -[:material-arrow-right: Description of Taipy Core entities](core/entities/index.md) - -## Taipy REST - `taipy.rest` - -The `taipy.rest` package allows you to access Taipy Core functionalities such as scenarios management, -pipelines and task orchestration, data management, etc., through a dedicated REST API. -This package aims to provide a solution to easily integrate Taipy applications with other IT systems. -The API comes with multiple endpoints for you to work with Taipy Core conveniently and efficiently. - -[:material-arrow-right: Taipy REST User Manual](rest/index.md) - -## Deployment - -[:material-arrow-right: Running & Deploying section](run-deploy/index.md) diff --git a/mkdocs.yml_template b/mkdocs.yml_template index ff7313f78..0bb6a8006 100644 --- a/mkdocs.yml_template +++ b/mkdocs.yml_template @@ -9,9 +9,9 @@ copyright: © [YEAR] Avaiga nav: - Home: - index.md - - "Installation": installation.md - "Getting Started": - getting_started/index.md + - "Install Taipy": installation.md [GETTING_STARTED_CONTENT] - "Manuals": - "User Manual":