Skip to content

Commit

Permalink
Merge pull request #797 from Avaiga/doc/fix-installation-guide
Browse files Browse the repository at this point in the history
Add Colab and Python version
  • Loading branch information
FlorianJacta committed Jan 22, 2024
1 parent caece36 commit 477c8c5
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ first application with ease.

# Installation with pip

1. **Prerequisites**: Ensure you have Python (version 3.8 or higher) and
1. **Prerequisites**: Ensure you have Python (**version between 3.8 and 3.11**) and
[pip](https://pip.pypa.io)installed.

2. **Installation Command**: Run the following in your terminal or command prompt:
``` console
$ pip install taipy
pip install taipy
```

For alternative installation methods or if you're lacking Python or pip, refer to the
Expand Down
43 changes: 35 additions & 8 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ powerful web applications.

# Prerequisite

Before installing Taipy, ensure you have Python (version 3.8 or above) and
Before installing Taipy, ensure you have Python (**between version 3.8 and 3.11**) 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:

Expand All @@ -27,7 +27,7 @@ follow these steps to install it:
Alternatively, if you are using a Conda environment, you can install pip using the following
command:

``` console
```console
$ conda install pip
```

Expand All @@ -38,12 +38,39 @@ To install Taipy, you have several options depending on your needs and preferenc
The preferred method to install Taipy is by using **pip**. Open your terminal or command prompt
and run the following command:

``` console
```console
$ pip install taipy
```

This command will download and install the most recent stable release of Taipy.


# Installing Taipy with Colab

Google Colab is a popular and free Jupyter notebook environment that requires no setup
and runs entirely in the cloud. To install Taipy in Google Colab, follow these simple
steps:

1. **Open a new Colab notebook**: Visit [Google Colab](https://colab.research.google.com)
and start a new notebook.

2. **Run the installation command**: In a new cell, enter the following command and run
the cell:

```python
!pip install --ignore-installed taipy
```

This command installs the latest stable release of Taipy in your Colab environment.

3. **Start building your app**: Follow this
[tip](../knowledge_base/tips/colab_with_ngrok/index.md) to build and run your Taipy web
application directly within the Colab notebook.

!!! tip
Remember that Google Colab environments are ephemeral. If you disconnect or restart
your Colab session, you will need to reinstall Taipy.

# Installing Taipy in a Conda Environment

Conda is an open-source package management system and environment management system that runs on
Expand All @@ -53,15 +80,15 @@ If you prefer to work within a [Conda](https://docs.conda.io/projects/conda/en/l
environment, follow these steps:

1. Create a new **Conda** environment (replace **env-name** with your desired environment name):
``` console
```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
```console
$ pip install taipy
```

Expand All @@ -71,21 +98,21 @@ If you want to work with the latest development version or contribute to the pro
install Taipy from the source code.

- Clone the public repository from GitHub (you'll need Git installed for this method):
``` console
```console
$ git clone git://github.com/avaiga/taipy
```

Or,
- Download the tarball directly from GitHub:
``` console
```console
$ curl -OJL https://github.com/avaiga/taipy/tarball/main
```

Once you have the source code, navigate to the directory containing the Taipy source code and
run the following command:

``` console
```console
$ pip install .
```

Expand Down

0 comments on commit 477c8c5

Please sign in to comment.