浏览代码

New installation.md (#2092)

* NEw installation.md

* New installation.md, code_of_conduct.md, and
CONTRIBUTING.md

* Add code organization

* remove unused contributors.txt

* Fix note and links

* Update INSTALLATION.md
Jean-Robin 6 月之前
父节点
当前提交
d6cfd7f4ae
共有 4 个文件被更改,包括 344 次插入213 次删除
  1. 11 13
      CODE_OF_CONDUCT.md
  2. 205 64
      CONTRIBUTING.md
  3. 128 116
      INSTALLATION.md
  4. 0 20
      contributors.txt

+ 11 - 13
CODE_OF_CONDUCT.md

@@ -1,6 +1,4 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
+# Our Pledge
 
 
 We as members, contributors, and leaders pledge to make participation in our
 We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 community a harassment-free experience for everyone, regardless of age, body
@@ -12,7 +10,7 @@ and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 diverse, inclusive, and healthy community.
 
 
-## Our Standards
+# Our Standards
 
 
 Examples of behavior that contributes to a positive environment for our
 Examples of behavior that contributes to a positive environment for our
 community include:
 community include:
@@ -36,7 +34,7 @@ Examples of unacceptable behavior include:
 * Other conduct which could reasonably be considered inappropriate in a
 * Other conduct which could reasonably be considered inappropriate in a
   professional setting.
   professional setting.
 
 
-## Enforcement Responsibilities
+# Enforcement Responsibilities
 
 
 Community leaders are responsible for clarifying and enforcing our standards of
 Community leaders are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
 acceptable behavior and will take appropriate and fair corrective action in
@@ -48,7 +46,7 @@ comments, commits, code, wiki edits, issues, and other contributions that are
 not aligned to this Code of Conduct, and will communicate reasons for moderation
 not aligned to this Code of Conduct, and will communicate reasons for moderation
 decisions when appropriate.
 decisions when appropriate.
 
 
-## Scope
+# Scope
 
 
 This Code of Conduct applies within all community spaces, and also applies when
 This Code of Conduct applies within all community spaces, and also applies when
 an individual is officially representing the community in public spaces.
 an individual is officially representing the community in public spaces.
@@ -56,7 +54,7 @@ Examples of representing our community include using an official e-mail address,
 posting via an official social media account, or acting as an appointed
 posting via an official social media account, or acting as an appointed
 representative at an online or offline event.
 representative at an online or offline event.
 
 
-## Enforcement
+# Enforcement
 
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
 reported to the community leaders responsible for enforcement at
@@ -66,12 +64,12 @@ All complaints will be reviewed and investigated promptly and fairly.
 All community leaders are obligated to respect the privacy and security of the
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
 reporter of any incident.
 
 
-## Enforcement Guidelines
+# Enforcement Guidelines
 
 
 Community leaders will follow these Community Impact Guidelines in determining
 Community leaders will follow these Community Impact Guidelines in determining
 the consequences for any action they deem in violation of this Code of Conduct:
 the consequences for any action they deem in violation of this Code of Conduct:
 
 
-### 1. Correction
+## 1. Correction
 
 
 **Community Impact**: Use of inappropriate language or other behavior deemed
 **Community Impact**: Use of inappropriate language or other behavior deemed
 unprofessional or unwelcome in the community.
 unprofessional or unwelcome in the community.
@@ -80,7 +78,7 @@ unprofessional or unwelcome in the community.
 clarity about the nature of the violation and an explanation of why the
 clarity about the nature of the violation and an explanation of why the
 behavior was inappropriate. A public apology may be requested.
 behavior was inappropriate. A public apology may be requested.
 
 
-### 2. Warning
+## 2. Warning
 
 
 **Community Impact**: A violation through a single incident or series
 **Community Impact**: A violation through a single incident or series
 of actions.
 of actions.
@@ -92,7 +90,7 @@ includes avoiding interactions in community spaces as well as external channels
 like social media. Violating these terms may lead to a temporary or
 like social media. Violating these terms may lead to a temporary or
 permanent ban.
 permanent ban.
 
 
-### 3. Temporary Ban
+## 3. Temporary Ban
 
 
 **Community Impact**: A serious violation of community standards, including
 **Community Impact**: A serious violation of community standards, including
 sustained inappropriate behavior.
 sustained inappropriate behavior.
@@ -103,7 +101,7 @@ private interaction with the people involved, including unsolicited interaction
 with those enforcing the Code of Conduct, is allowed during this period.
 with those enforcing the Code of Conduct, is allowed during this period.
 Violating these terms may lead to a permanent ban.
 Violating these terms may lead to a permanent ban.
 
 
-### 4. Permanent Ban
+## 4. Permanent Ban
 
 
 **Community Impact**: Demonstrating a pattern of violation of community
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior,  harassment of an
 standards, including sustained inappropriate behavior,  harassment of an
@@ -112,7 +110,7 @@ individual, or aggression toward or disparagement of classes of individuals.
 **Consequence**: A permanent ban on any sort of public interaction within
 **Consequence**: A permanent ban on any sort of public interaction within
 the community.
 the community.
 
 
-## Attribution
+# Attribution
 
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
 version 2.0, available at

+ 205 - 64
CONTRIBUTING.md

@@ -1,38 +1,42 @@
-# Contributions
+# General contributions
 
 
-Thanks for your interest in helping improve Taipy! Contributions are welcome, and they are greatly appreciated!
-Every little help and credit will always be given.
+Thanks for your interest in helping improve Taipy! Contributions are welcome, and they are greatly
+appreciated! Every little help and credit will always be given.
 
 
-There are multiple ways to contribute to Taipy: code, but also reporting bugs, creating feature requests, helping
-other users in our forums, [stack**overflow**](https://stackoverflow.com/), etc.
+There are multiple ways to contribute to Taipy: code, but also reporting bugs, creating feature
+requests, helping other users in our forums, [stack**overflow**](https://stackoverflow.com/), etc.
 
 
-For questions, please get in touch on [Discord](https://discord.com/invite/SJyz2VJGxV) or on GitHub with a discussion or an issue.
+For questions, please get in touch on [Discord](https://discord.com/invite/SJyz2VJGxV) or on GitHub
+with a discussion or an issue.
 
 
-## Code organisation
+## Project organisation
 
 
 Taipy is organised in two main repositories:
 Taipy is organised in two main repositories:
 
 
-- [taipy](https://github.com/Avaiga/taipy) is the main repository that contains the code of Taipy packages.
+- [taipy](https://github.com/Avaiga/taipy) is the main repository that contains the code of Taipy
+    packages.
 - [taipy-doc](https://github.com/Avaiga/taipy-doc) is the documentation repository.
 - [taipy-doc](https://github.com/Avaiga/taipy-doc) is the documentation repository.
 
 
 ## Never contributed to an open source project before ?
 ## Never contributed to an open source project before ?
 
 
-Have a look at this [GitHub documentation](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
+Have a look at this
+[GitHub documentation](https://docs.github.com/en/get-started/quickstart/contributing-to-projects).
 
 
 ## Report bugs
 ## Report bugs
 
 
 Reporting bugs is through [GitHub issues](https://github.com/Avaiga/taipy/issues).
 Reporting bugs is through [GitHub issues](https://github.com/Avaiga/taipy/issues).
 
 
-Please report relevant information and preferably code that exhibits the problem. We provide templates to help you
-describe the issue.
+Please report relevant information and preferably code that exhibits the problem. We provide
+templates to help you describe the issue.
 
 
-The Taipy team will analyze and try to reproduce the bug to provide feedback. If confirmed, we will add a priority
-to the issue and add it in our backlog. Feel free to propose a pull request to fix it.
+The Taipy team will analyze and try to reproduce the bug to provide feedback. If confirmed,
+we will add a priority to the issue and add it in our backlog. Feel free to propose a pull
+request to fix it.
 
 
 ## Issue reporting, feedback, proposal, design or any other comment
 ## Issue reporting, feedback, proposal, design or any other comment
 
 
-Any feedback or proposal is greatly appreciated! Do not hesitate to create an issue with the appropriate template on
-[GitHub](https://github.com/Avaiga/taipy/issues).
+Any feedback or proposal is greatly appreciated! Do not hesitate to create an issue with the
+appropriate template on [GitHub](https://github.com/Avaiga/taipy/issues).
 
 
 The Taipy team will analyse your issue and return to you as soon as possible.
 The Taipy team will analyse your issue and return to you as soon as possible.
 
 
@@ -41,19 +45,35 @@ The Taipy team will analyse your issue and return to you as soon as possible.
 Do not hesitate to create an issue or pull request directly on the
 Do not hesitate to create an issue or pull request directly on the
 [taipy-doc repository](https://github.com/Avaiga/taipy-doc).
 [taipy-doc repository](https://github.com/Avaiga/taipy-doc).
 
 
-## Implement Features
+# Code contributions
 
 
+## Code organization
+
+The Taipy source code is located in the [taipy](https://github.com/Avaiga/taipy)
+repository, in the `taipy` directory.
+
+Packages sources are organized in subdirectories from there:
+
+- `taipy-common`
+- `taipy-core`
+- `taipy-gui`
+- `taipy-rest`
+- `taipy-templates`
+
+## Process and workflow
+
+### Issue assignment
 The Taipy team manages its backlog in private. Each issue that is or is going to be engaged by the
 The Taipy team manages its backlog in private. Each issue that is or is going to be engaged by the
-Taipy team is attached to the "🔒 Staff only" label or has already been assigned to a Taipy team member.
-Please, do not work on it, the Taipy team is on it.
+Taipy team is attached to the "🔒 Staff only" label or has already been assigned to a Taipy team
+member. Please, do not work on it, the Taipy team is on it.
 
 
 All other issues are sorted by labels and are available for a contribution. If you are new to the
 All other issues are sorted by labels and are available for a contribution. If you are new to the
-project, you can start with the "good first issue" or "🆘 Help wanted" label. You can also start with
-issues with higher priority, like "Critical" or "High". The higher the priority, the more value it
-will bring to Taipy.
+project, you can start with the "good first issue" or "🆘 Help wanted" label. You can also start
+with issues with higher priority, like "Critical" or "High". The higher the priority, the more
+value it will bring to Taipy.
 
 
-If you want to work on an issue, please add a comment and wait to be assigned to the issue to inform
-the community that you are working on it.
+If you want to work on an issue, please add a comment and wait to be assigned to the issue to
+inform the community that you are working on it. Then, follow the steps below:
 
 
 ### Contribution workflow
 ### Contribution workflow
 
 
@@ -61,36 +81,48 @@ the community that you are working on it.
    targeted by the issue. Clone it on your local machine, then go inside the directory.
    targeted by the issue. Clone it on your local machine, then go inside the directory.
 
 
 2. We are working with [Pipenv](https://github.com/pypa/pipenv) for our virtualenv.
 2. We are working with [Pipenv](https://github.com/pypa/pipenv) for our virtualenv.
-   Create a local env and install development package by running `$ pipenv install --dev`, then run tests with
-   `$ pipenv run pytest` to verify your setup.
+   Create a local env and install development package by running `$ pipenv install --dev`, then
+   run tests with `$ pipenv run pytest` to verify your setup.
 
 
 3. For convention help, we provide a [pre-commit](https://pre-commit.com/hooks.html) file.
 3. For convention help, we provide a [pre-commit](https://pre-commit.com/hooks.html) file.
-   This tool will run before each commit and will automatically reformat code or raise warnings and errors based on the
-   code format or Python typing.
-   You can install and set it up by doing:
+   This tool will run before each commit and will automatically reformat code or raise warnings
+   and errors based on the code format or Python typing. You can install and set it up by doing:
    ```bash
    ```bash
    $ pipenv install pre-commit
    $ pipenv install pre-commit
    $ pipenv run python -m pre-commit install
    $ pipenv run python -m pre-commit install
    ```
    ```
 
 
-4. Make the changes.<br/>
-   You may want to also add your GitHub login as a new line of the `contributors.txt` file located at the root
-   of this repository. We are using it to list our contributors in the Taipy documentation
-   (see the "Contributing > Contributors" section) and thank them.
-
-5. Create a [pull request from your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).<br/>
+4. Create a [pull request from your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork).<br/>
    Keep your pull request as __draft__ until your work is finished.
    Keep your pull request as __draft__ until your work is finished.
    Do not hesitate to add a comment for help or questions.
    Do not hesitate to add a comment for help or questions.
-   Before you submit a pull request for review from your forked repo, check that it meets these guidelines:
-     - The code and the branch name follow the [Taipy coding style](#coding-style-and-best-practices).
+   Before you submit a pull request for review from your forked repo, check that it meets these
+   guidelines:
+     - The code and the branch name follow the
+         [Taipy coding style](#coding-style-and-best-practices).
      - Include tests.
      - Include tests.
      - Code is [rebased](http://stackoverflow.com/a/7244456/1110993).
      - Code is [rebased](http://stackoverflow.com/a/7244456/1110993).
      - License is present.
      - License is present.
      - pre-commit works - without mypy errors.
      - pre-commit works - without mypy errors.
      - Taipy tests are passing.
      - Taipy tests are passing.
 
 
-6. The Taipy team will have a look at your Pull Request and will give feedback. If every requirement is valid, your
-   work will be added in the next release, congratulations!
+5. The Taipy team will have a look at your Pull Request and will give feedback. If every
+    requirement is valid, your work will be added in the next release, congratulations!
+
+### Issues or Pull requests inactivity
+
+- If your PR is not created or there is no other activity within 14 days of being assigned to
+    the issue, a warning message will appear on the issue, and the issue will be marked as
+    "🥶Waiting for contributor".
+- If your issue is marked as "🥶Waiting for contributor", you will be unassigned after 14
+    days of inactivity.
+- Similarly, if there is no activity within 14 days of your PR, the PR will be marked as
+    "🥶Waiting for contributor".
+- If your PR is marked as "🥶Waiting for contributor", it will be closed after 14 days of
+    inactivity.
+
+We do this in order to keep our backlog moving quickly. Please don't take it personally if your
+issue or PR gets closed because of this 14-day inactivity time limit. You can always reopen the
+issue or PR if you're still interested in working on it.
 
 
 ## Coding style and best practices
 ## Coding style and best practices
 
 
@@ -99,15 +131,16 @@ the community that you are working on it.
 Taipy's repositories follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) and
 Taipy's repositories follow the [PEP 8](https://www.python.org/dev/peps/pep-0008/) and
 [PEP 484](https://www.python.org/dev/peps/pep-0484/) coding convention.
 [PEP 484](https://www.python.org/dev/peps/pep-0484/) coding convention.
 
 
-## TypeScript
+### TypeScript
 
 
 Taipy's repositories use the [ESLint](https://eslint.org/) and
 Taipy's repositories use the [ESLint](https://eslint.org/) and
 [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint) plugin to ensure a common set of rules.
 [TypeScript ESLint](https://github.com/typescript-eslint/typescript-eslint) plugin to ensure a common set of rules.
 
 
 ### Git branches
 ### Git branches
 
 
-All new development happens in the `develop` branch. All pull requests should target that branch.
-We are following a strict branch naming convention based on the pattern: `<type>/#<issueId>[IssueSummary]`.
+All new development happens in the `develop` branch. All pull requests should target that
+branch. We are following a strict branch naming convention based on the pattern:
+`<type>/#<issueId>[IssueSummary]`.
 
 
 Where:
 Where:
 
 
@@ -118,31 +151,139 @@ Where:
     - refactor: refactor of a piece of code.
     - refactor: refactor of a piece of code.
     - doc: doc changes (complement or typo fixes…).
     - doc: doc changes (complement or typo fixes…).
     - build: in relation with the build process.
     - build: in relation with the build process.
-- `<issueId>` is the processed issue identifier. The advantage of explicitly indicating the issue number is that in
-  GitHub, a pull request page shows a direct link to the issue description.
-- `[IssueSummary]` is a short summary of the issue topic, not including spaces, using Camel case or lower-case,
-  dash-separated words. This summary, with its dash (‘-’) symbol prefix, is optional.
-
-## Important Notes
-
-- If your PR is not created or there is no other activity within 14 days of being assigned to the issue, a warning message will appear on the issue, and the issue will be marked as "🥶Waiting for contributor".
-- If your issue is marked as "🥶Waiting for contributor", you will be unassigned after 14 days of inactivity.
-- Similarly, if there is no activity within 14 days of your PR, the PR will be marked as "🥶Waiting for contributor".
-- If your PR is marked as "🥶Waiting for contributor", it will be closed after 14 days of inactivity.
-
-We do this in order to keep our backlog moving quickly. Please don't take it personally if your issue or PR gets closed
-because of this 14-day inactivity time limit. You can always reopen the issue or PR if you're still interested in working
-on it.
+- `<issueId>` is the processed issue identifier. The advantage of explicitly indicating the issue
+    number is that inGitHub, a pull request page shows a direct link to the issue description.
+- `[IssueSummary]` is a short summary of the issue topic, not including spaces, using Camel case
+    or lower-case, dash-separated words. This summary, with its dash (‘-’) symbol prefix, is
+    optional.
 
 
 ## Dependency management
 ## Dependency management
 
 
-Taipy comes with multiple optional packages. You can find the list directly in the product or Taipy's packages.
-The back-end Pipfile does not install optional packages by default due to `pyodbc` requiring a driver's manual
-installation. This is not the behaviour for the front-end that installs all optional packages through its Pipfile.
+Taipy comes with multiple optional packages. You can find the list directly in the product or
+Taipy's packages. The back-end Pipfile does not install optional packages by default due to
+`pyodbc` requiring a driver's manual installation. This is not the behaviour for the front-end
+that installs all optional packages through its Pipfile.
+
+If you are a contributor on Taipy, be careful with dependencies, do not forget to install or
+uninstall depending on your issue.
+
+If you need to add a new dependency to Taipy, do not forget to add it in the `Pipfile` and the
+`setup.py`. Keep in mind that dependency is a vector of attack. The Taipy team limits the usage
+of external dependencies at the minimum.
+
+## Installing the development kit
+
+If you need the source code for Taipy on your system to see how things are done or maybe
+contribute to the improvement of the packages, you can set your environment up by following
+the steps below.
 
 
-If you are a contributor on Taipy, be careful with dependencies, do not forget to install or uninstall depending on
-your issue.
+### Prerequisites
+Before installing the Taipy development kit, ensure you have
+[Python](http://docs.python-guide.org/en/latest/starting/installation/) (**version 3.9 or later**),
+[pip](https://pip.pypa.io/en/latest/installation/), and
+[git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) installed on your system.
+
+??? note "On Mac OS M1 pro"
 
 
-If you need to add a new dependency to Taipy, do not forget to add it in the `Pipfile` and the `setup.py`.
-Keep in mind that dependency is a vector of attack. The Taipy team limits the usage of external dependencies at the
-minimum.
+    If you are using a Mac OS M1 pro, you may need to install the `libmagic` library before.
+    Please run the commands below:
+    ```bash
+    brew install libmagic
+    pip install python-libmagic
+    ```
+
+### Cloning the repository
+
+First, clone the Taipy repository from GitHub using the following command:
+
+```bash
+git clone https://github.com/Avaiga/taipy.git
+```
+
+This creates the 'taipy' directory holding all the package's source code.
+
+### Building the JavaScript bundles
+
+Taipy (and Taipy GUI) includes client-side code for web applications, written in
+[TypeScript](https://www.typescriptlang.org/), and uses [React](https://reactjs.org/).
+The code is packaged into JavaScript bundles that are sent to browsers when accessing
+Taipy applications with a graphical interface.
+
+There are two main JavaScript bundles to build:
+- Taipy GUI: Contains the web application, the pages and all standard visual elements.
+- Taipy: Contains specific visual elements for Taipy back-end functionalities
+    (Scenario Management).
+
+**Prerequisites**: To build the JavaScript bundles, ensure you have [Node.js](https://nodejs.org/)
+version 18 or higher installed. Node.js includes the
+[`npm` package manager](https://www.npmjs.com/).
+
+The build process is explained in the
+[Taipy GUI front-end](https://github.com/Avaiga/taipy/blob/develop/frontend/taipy-gui/README.md)
+and
+[Taipy front-end](https://github.com/Avaiga/taipy/blob/develop/frontend/taipy/README.md) README
+files. Build the Taipy GUI bundle first, as the Taipy front-end depends on it.
+
+**Build instructions:** Run the following commands from the root directory of the repository:
+
+```bash
+# Build the Taipy GUI bundle
+cd frontend/taipy-gui
+cd dom
+npm i
+cd ..
+npm i
+npm run build
+#
+# Build the Taipy front-end bundle
+cd ../taipy # Current directory is [taipy-dir]/frontend/taipy
+npm i
+npm run build
+```
+
+These commands will create the `taipy/gui/webapp` and `taipy/gui_core/lib` directories in the root
+folder of the taipy repository.
+
+### Debugging the JavaScript bundles
+
+If you plan to modify the front-end code and need to debug the TypeScript code, you must use the
+following instead of the *standard* build option:
+```bash
+npm run build:dev
+```
+
+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/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
+
+The Taipy package includes a test suite to ensure the package's functionality is correct.
+The tests are written using the [pytest](https://docs.pytest.org/en/latest/) framework.
+They are located in the `tests` directory of the package.
+
+To run the tests, you need to install the required development packages. We recommend using
+[Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment and install the
+development packages.
+
+```bash
+pip install pipenv
+pipenv install --dev
+```
+
+Then you can run the tests with the following command:
+
+```bash
+pipenv run pytest
+```

+ 128 - 116
INSTALLATION.md

@@ -1,159 +1,171 @@
-# Taipy Installation Guide
+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.
 
 
-Taipy can be installed in various ways depending on your needs. 
+!!! note "Installation for Contributing to Taipy"
 
 
-If you aim to modify the code or contribute to its development, refer to the 
+    If you aim to modify the Taipy source code or contribute to its development, please refer
+    to the contributing page to get more information.
 
 
-[source installation](#installing-for-development) section. 
+# Installing Taipy library
 
 
-Ensure that you have Python 3.9 or above installed on your system.
+## Prerequisite
 
 
-## Installing Taipy from PyPI
+Before installing Taipy, ensure you have Python (**version 3.9 or later**) 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:
 
 
-The easiest way to install Taipy is through the 
+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.
 
 
-[PyPI software repository](https://pypi.org/project/taipy/). 
+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`.
 
 
-You can do this by running the following command:
+Alternatively, if you are using a Conda environment, you can install pip using the following
+command:
+```console
+conda install pip
+```
 
 
-```bash
+## The latest stable release from Pypi
+
+### Pip
+The preferred method to install Taipy is by using **pip**. After downloading Taipy package
+from **[PyPI repository](https://pypi.org/project/taipy/)** the following commands install
+it in the Python environment with all its dependencies. Open your terminal or command prompt
+and run the following command:
+```console
 pip install taipy
 pip install taipy
 ```
 ```
 
 
-If you are using a virtual environment, use:
-
-```bash
+### Pipenv
+If you are using a virtual environment with **[Pipenv](https://pipenv.pypa.io/en/latest/)**,
+use the following command:
+```console
 pipenv install taipy
 pipenv install taipy
 ```
 ```
 
 
-Alternatively, you can use `venv` to create a virtual environment:
-```bash
-python -m venv myenv
-source myenv/bin/activate  # On Windows use `myenv\Scripts\activate`
+### Venv
+Alternatively, you can use `venv` to create a virtual environment. Please run the following
+commands replacing `<myenv>` (twice) with your desired environment name:
+```console
+python -m venv <myenv>
+source myenv/bin/activate  # On Windows use `<myenv>\Scripts\activate`
 pip install taipy
 pip install taipy
 ```
 ```
 
 
-These commands install the `taipy` package in the Python environment with all its
-dependencies.
+### Conda
+If you prefer to work within a [Conda](https://docs.conda.io/projects/conda/en/latest/index.html)
+environment, you can install Taipy using the following commands replacing `<myenv>` with your
+desired environment name:
+```console
+conda create -n <myenv>
+conda activate <myenv>
+pip install taipy
+```
 
 
-## Installing a Specific Version from PyPI
+## A specific version from PyPI
 
 
-To install a specific version of Taipy, use the following command:
-```bash
+### Pip
+To install a specific version of Taipy, use the following command replacing `<version>` with a
+specific version number of Taipy among the
+**[list of all released Taipy versions](https://pypi.org/project/taipy/#history)**:
+```console
 pip install taipy==<version>
 pip install taipy==<version>
 ```
 ```
-Replace `<version>` with a specific version number of Taipy.
-The list of all released Taipy versions can be found [here](https://pypi.org/project/taipy/#history).
-
-## Installing from GitHub
-
-The development version of Taipy is updated daily with changes from the Taipy R&D and external
-contributors whom we praise for their input.
 
 
-The development version of Taipy can be installed using *pip* and *git*:
-
-```bash
-pip install git+https://git@github.com/Avaiga/taipy
+### Pipenv
+If you are using a virtual environment with **[Pipenv](https://pipenv.pypa.io/en/latest/)**,
+use the following command:
+```console
+pipenv install taipy==<version>
 ```
 ```
 
 
-## Installing for development
-
-If you need the source code for Taipy 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:
+### Venv
+Alternatively, you can use `venv` to create a virtual environment:
+```console
+python -m venv myenv
+source myenv/bin/activate  # On Windows use `myenv\Scripts\activate`
+pip install taipy==<version>
+```
 
 
-```bash
-git clone https://github.com/Avaiga/taipy.git
+### Conda
+If you prefer to work within a [Conda](https://docs.conda.io/projects/conda/en/latest/index.html)
+environment, you can install Taipy using the following commands replacing `<myenv>` with your
+desired environment name:
+```console
+conda create -n <myenv>
+conda activate <myenv>
+pip install taipy==<version>
 ```
 ```
 
 
-This creates the 'taipy' directory holding all the package's source code.
+## A development version from GitHub
 
 
-### Building the JavaScript bundles
+### Pip
+The development version of Taipy is hosted on
+**[GitHub repository](https://git@github.com/Avaiga/taipy)** using the `develop` branch. This
+branch is updated daily with changes from the Taipy R&D team and external contributors whom we
+praise for their input.
 
 
-Taipy (and Taipy GUI that it embeds) has some code dealing with the client side of the web
-applications.<br/>
-This code is written in [TypeScript](https://www.typescriptlang.org/), relies on
-[React](https://reactjs.org/) components, and is packaged into JavaScript bundles that are sent to
-browsers when they connect to all Taipy applications that have a graphical interface.
+The development version of Taipy can be installed using **pip**. After downloading Taipy source
+code from the **[GitHub repository](https://git@github.com/Avaiga/taipy)** the following commands
+build the package, and install it in the Python environment with all its dependencies.
 
 
-There are two main JavaScript bundles that can be built:
-- Taipy GUI: All the graphical interfaces that Taipy GUI can generate are based on a set of
-  generated files, including the web application and all the predefined visual elements.
-- Taipy: A set of visual elements dedicated to Scenario Management.
+Open your terminal or command prompt and run the following command:
 
 
-**Prerequisites**: If you need to build the JavaScript bundle, you need to make sure that the
-[Node.js](https://nodejs.org/) JavaScript runtime version 18 or above is installed on your
-machine.<br/>
-Note that Node.js comes with the [`npm` package manager](https://www.npmjs.com/) as part
-of the standard installation.
+```bash
+pip install git+https://git@github.com/Avaiga/taipy
+```
 
 
-The build process is described in the [Taipy GUI front-end](frontend/taipy-gui/README.md) and
- [Taipy front-end](frontend/taipy/README.md) README files.<br/>
- The Taipy GUI bundle must be built first, as the Taipy front-end code depends on it.
+### Pipenv
+If you are using a virtual environment with **[Pipenv](https://pipenv.pypa.io/en/latest/)**,
+use the following command:
+```console
+pipenv install git+https://git@github.com/Avaiga/taipy
+```
 
 
-Here is the sequence of commands that can be issued to build both sets of files:
+### Venv
+Alternatively, you can use `venv` to create a virtual environment:
+```console
+python -m venv myenv
+source myenv/bin/activate  # On Windows use `myenv\Scripts\activate`
+pip install git+https://git@github.com/Avaiga/taipy
+```
 
 
-```bash
-# Current directory is the repository's root directory
-#
-# Build the Taipy GUI bundle
-cd frontend/taipy-gui
-cd dom
-npm i
-cd ..
-npm i
-npm run build
-#
-# Build the Taipy front-end bundle
-cd ../taipy # Current directory is [taipy-dir]/frontend/taipy
-npm i
-npm run build
+### Conda
+If you prefer to work within a [Conda](https://docs.conda.io/projects/conda/en/latest/index.html)
+environment, you can install Taipy using the following commands replacing `<myenv>` with your
+desired environment name:
+```console
+conda create -n <myenv>
+conda activate <myenv>
+pip install git+https://git@github.com/Avaiga/taipy
 ```
 ```
 
 
-These commands should create the directories `taipy/gui/webapp` and `taipy/gui_core/lib` in the
-root directory of the taipy repository.
+# Installing Taipy with Colab
 
 
-### Debugging the JavaScript bundles
+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:
 
 
-If you plan to modify the front-end code and need to debug the TypeScript
-code, you must use the following:
-```bash
-npm run build:dev
-```
+1. **Open a new Colab notebook**: Visit [Google Colab](https://colab.research.google.com)
+    and start a new notebook.
 
 
-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/gui/webapp` directory.<br/>
-> 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.<br/>
-> 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 install the required development packages.
-We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtual environment
-and install the development packages.
+2. **Run the installation command**: In a new cell, enter the following command and run
+    the cell to install the latest stable release of Taipy in your Colab environment:
 
 
-```bash
-pip install pipenv
-pipenv install --dev
-```
+    ```python
+    !pip install --ignore-installed taipy
+    ```
 
 
-Then you can run the tests with the following command:
+3. **Start building your app**: Follow this
+    [tutorial](https://docs.taipy.io/en/latest/tutorials/articles/colab_with_ngrok/) to build
+    and run your Taipy web application directly within the Colab notebook.
 
 
-```bash
-pipenv run pytest
-```
+!!! tip
+    Remember that Google Colab environments are ephemeral. If you disconnect or restart
+    your Colab session, you will need to reinstall Taipy.

+ 0 - 20
contributors.txt

@@ -1,20 +0,0 @@
-jrobinAV
-FabienLelaquais
-florian-vuillemot
-FredLL-Avaiga
-dinhlongviolin1
-joaoandre-avaiga
-toan-quach
-trgiangdo
-gmarabout
-tsuu2092
-arcanaxion
-Dr-Irv
-enarroied
-bobbyshermi
-Forchapeatl
-yarikoptic
-Luke-0162
-Satoshi-Sh
-kushal34712
-DeepanshuProgrammer