Pārlūkot izejas kodu

feat: update README.md and INSTALLATION.md files

trgiangdo 1 gadu atpakaļ
vecāks
revīzija
f51b657e9d

+ 17 - 12
INSTALLATION.md

@@ -13,12 +13,12 @@ The easiest way to install Taipy is from the
 [Pypi software repository](https://pypi.org/project/taipy/).
 
 Run the command:
-```console
+```bash
 $ pip install taipy
 ```
 
 If you are running in a virtual environment, you will have to issue the command:
-```console
+```bash
 $ pipenv install taipy
 ```
 
@@ -32,7 +32,7 @@ contributors whom we praise for their input.
 
 The development version of Taipy can be installed using *pip* and *git*:
 
-```console
+```bash
 $ pip install git+https://git@github.com/Avaiga/taipy
 ```
 
@@ -41,7 +41,7 @@ $ pip install git+https://git@github.com/Avaiga/taipy
 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:
 
-```console
+```bash
 $ git clone https://github.com/Avaiga/taipy.git
 ```
 
@@ -72,7 +72,7 @@ The build process is described in the [Taipy GUI front-end](frontend/taipy-gui/R
 
 Here is the sequence of commands that can be issued to build both sets of files:
 
-```console
+```bash
 # Current directory is the repository's root directory
 #
 # Build the Taipy GUI bundle
@@ -96,7 +96,7 @@ root directory of the taipy repository.
 
 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
 ```
 
@@ -124,12 +124,17 @@ TypeScript code from your debugger.
 
 ## Running the tests
 
-To run the tests on the package, you need to create a virtual
-environment and install the development packages:
+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.
+
+```bash
+$ pip install pipenv
+$ pipenv install --dev
+```
 
-Here are the commands to issue:
+Then you can run the tests with the following command:
 
-```console
-pipenv install --dev
-pipenv run pytest
+```bash
+$ pipenv run pytest
 ```

+ 30 - 16
taipy/config/INSTALLATION.md

@@ -1,29 +1,43 @@
 # Installation
 
 The latest stable version of _taipy-config_ is available through _pip_:
-```
-pip install taipy-config
+```bash
+$ pip install taipy-config
 ```
 
 ## Development version
 
-You can install the development version of _taipy-config_ with _pip_ and _git_:
-```
-pip install git+https://git@github.com/Avaiga/taipy-config
+You can install the development version of _taipy-config_ with _pip_ and _git_ via the taipy repository:
+```bash
+$ pip install git+https://git@github.com/Avaiga/taipy
 ```
 
-## Work with the _taipy-config_ code
-```
-git clone https://github.com/Avaiga/taipy-config.git
-cd taipy-config
-pip install .
+This command installs the development version of _taipy_ package in the Python environment with all
+its dependencies, including the _taipy-config_ package.
+
+If you need the source code for _taipy-config_ 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
 ```
 
-If you want to run tests, please install `Pipenv`:
+This creates the 'taipy' directory holding all the package's source code, and the 'taipy-config'
+source code is in the 'taipy/config' directory.
+
+## 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.
+
+```bash
+$ pip install pipenv
+$ pipenv install --dev
 ```
-pip install pipenv
-git clone https://github.com/Avaiga/taipy-config.git
-cd taipy-config
-pipenv install --dev
-pipenv run pytest
+
+Then you can run _taipy-config_ tests with the following command:
+
+```bash
+$ pipenv run pytest tests/config
 ```

+ 18 - 22
taipy/config/README.md

@@ -1,11 +1,3 @@
-# 🚧 Under construction 🚧
-
-WARNING: The Taipy team is performing a repository restructuration. This current repository taipy-config is about to be
-merged into the main repository: taipy. Once the merge is done, the current code base will be in the
-[taipy repository](https://github.com/Avaiga/taipy). The migration should take a maximum of a few days.
-<br>
-
-
 # Taipy config
 
 ## License
@@ -34,7 +26,7 @@ Taipy is a Python library for creating Business Applications. More information o
 [website](https://www.taipy.io). Taipy is split into multiple repositories including _taipy-config_ to let users
 install the minimum they need.
 
-[Taipy config](https://github.com/Avaiga/taipy-config) is dedicated to helping the user configure a Taipy application.
+Taipy config is dedicated to helping the user configure a Taipy application.
 
 More in-depth documentation of taipy can be found [here](https://docs.taipy.io).
 
@@ -53,16 +45,20 @@ Want to be part of the _Taipy config_ community? Check out our [`CODE_OF_CONDUCT
 ## Directory Structure
 
 - `taipy/`:
-    - `config`: Configuration definition, management, and implementation. `config.config.Config` is the main
-      entrypoint for configuring a Taipy Core application.
-    - `logger`: Taipy logger.
-    - `tests`: Unit tests following the `taipy/` structure.
-- `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-config_.
-- `CONTRIBUTING.md`: Instructions to contribute to _taipy-config_.
-- `INSTALLATION.md`: Instructions to install _taipy-config_.
-- `LICENSE`: The Apache 2.0 License.
-- `Pipfile`: File used by the Pipenv virtual environment to manage project dependencies.
-- `README.md`: Current file.
-- `contributors.txt`: The list of contributors.
-- `setup.py`: The setup script managing building, distributing, and installing _taipy-config_.
-- `tox.ini`: Contains test scenarios to be run.
+  - `config/`: Configuration definition, management, and implementation. `taipy.Config` is the main entrypoint for configuring a Taipy Core application.
+    - `_config_comparator/`: Internal package for comparing configurations.
+    - `_serializer/`: Internal package for serializing and deserializing configurations.
+    - `checker/`: Configuration checker and issue collector implementation.
+    - `common/`: Shared data structures, types, and functions.
+    - `exceptions/`: _taipy-config_ exceptions.
+    - `global_app/`: GlobalAppConfig implementation.
+    - `stubs/`: Helper functions to create the _config.pyi_ file.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-config_.
+    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-config_.
+    - `INSTALLATION.md`: Instructions to install _taipy-config_.
+    - `LICENSE`: The Apache 2.0 License.
+    - `README.md`: Current file.
+    - `setup.py`: The setup script managing building, distributing, and installing _taipy-config_.
+  - `logger/`: Taipy logger implementation.
+- `tests/`:
+  - `config/`: Tests for the _taipy-config_ package.

+ 29 - 15
taipy/core/INSTALLATION.md

@@ -1,29 +1,43 @@
 # Installation
 
 The latest stable version of _taipy-core_ is available through _pip_:
-```
+```bash
 pip install taipy-core
 ```
 
 ## Development version
 
-You can install the development version of _taipy_ with _pip_ and _git_:
-```
-pip install git+https://git@github.com/Avaiga/taipy-core
+You can install the development version of _taipy-core_ with _pip_ and _git_ via the taipy repository:
+```bash
+$ pip install git+https://git@github.com/Avaiga/taipy
 ```
 
-## Work with the _taipy-core_ code
-```
-git clone https://github.com/Avaiga/taipy-core.git
-cd taipy-core
-pip install .
+This command installs the development version of _taipy_ package in the Python environment with all
+its dependencies, including the _taipy-core_ package.
+
+If you need the source code for _taipy-core_ 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
 ```
 
-If you want to run tests, please install `Pipenv`:
+This creates the 'taipy' directory holding all the package's source code, and the 'taipy-core'
+source code is in the 'taipy/core' directory.
+
+## 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.
+
+```bash
+$ pip install pipenv
+$ pipenv install --dev
 ```
-pip install pipenv
-git clone https://github.com/Avaiga/taipy-core.git
-cd taipy-core
-pipenv install --dev
-pipenv run pytest
+
+Then you can run _taipy-core_ tests with the following command:
+
+```bash
+$ pipenv run pytest tests/core
 ```

+ 29 - 30
taipy/core/README.md

@@ -1,8 +1,5 @@
 # Taipy Core
 
-[![Python](https://img.shields.io/pypi/pyversions/taipy-core)](https://pypi.org/project/taipy-core)
-[![PyPI](https://img.shields.io/pypi/v/taipy-core.svg?label=pip&logo=PyPI&logoColor=white)](https://pypi.org/project/taipy-core)
-
 ## License
 
 Copyright 2021-2024 Avaiga Private Limited
@@ -33,7 +30,7 @@ Taipy is a Python library for creating Business Applications. More information o
 [website](https://www.taipy.io). Taipy is split into multiple repositories including
 _taipy-core_ to let users install the minimum they need.
 
-[Taipy Core](https://github.com/Avaiga/taipy-core) mostly includes business-oriented
+Taipy Core mostly includes business-oriented
 features. It helps users create and manage business applications and improve analyses
 capability through time, conditions and hypothesis.
 
@@ -54,29 +51,31 @@ Want to be part of the _Taipy Core_ community? Check out our
 
 ## Directory Structure
 
-- `src/`:
-  - `taipy/core/`:
-    - `_manager`: Internal package for entity manager.
-    - `_repository`: Internal package for data storage.
-    - `_orchestrator`: Internal package for task orchestrating and execution.
-    - `_version`: Internal package for managing Taipy Core application version.
-    - `common`: Shared data structures, types, and functions.
-    - `config`: Configuration definition, management and implementation.
-    - `cycle`: Work cycle definition, management and implementation.
-    - `data`: Data Node definition, management and implementation.
-    - `exceptions`: _taipy-core_ exceptions.
-    - `job`: Job definition, management and implementation.
-    - `sequence`: Sequence definition, management and implementation.
-    - `scenario`: Scenario definition, management and implementation.
-    - `task`: Task definition, management and implementation.
-    - `taipy`: Main entrypoint for _taipy-core_ runtime features.
-- `tests`: Unit tests following the `taipy/core/` structure.
-- `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-core_.
-- `CONTRIBUTING.md`: Instructions to contribute to _taipy-core_.
-- `INSTALLATION.md`: Instructions to install _taipy-core_.
-- `LICENSE`: The Apache 2.0 License.
-- `Pipfile`: File used by the Pipenv virtual environment to manage project dependencies.
-- `README.md`: Current file.
-- `contributors.txt`: The list of contributors.
-- `setup.py`: The setup script managing building, distributing, and installing _taipy-core_.
-- `tox.ini`: Contains test scenarios to be run.
+- `taipy/`:
+  - `core/`:
+    - `_backup/`: Internal package for Taipy data backup mechanism.
+    - `_entity/`: Internal package for abstract entity definition and entity's properties management.
+    - `_manager/`: Internal package for entity manager.
+    - `_orchestrator/`: Internal package for task orchestrating and execution.
+    - `_repository/`: Internal package for data storage.
+    - `_version/`: Internal package for managing Taipy Core application version.
+    - `common/`: Shared data structures, types, and functions.
+    - `config/`: Configuration definition, management and implementation.
+    - `cycle/`: Work cycle definition, management and implementation.
+    - `data/`: Data Node definition, management and implementation.
+    - `exceptions/`: _taipy-core_ exceptions.
+    - `job/`: Job definition, management and implementation.
+    - `notification/`: Notification management system implementation.
+    - `scenario/`: Scenario definition, management and implementation.
+    - `sequence/`: Sequence definition, management and implementation.
+    - `submission/`: Submission definition, management and implementation.
+    - `task/`: Task definition, management and implementation.
+    - `taipy.py`: Main entrypoint for _taipy-core_ runtime features.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-core_.
+    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-core_.
+    - `INSTALLATION.md`: Instructions to install _taipy-core_.
+    - `LICENSE`: The Apache 2.0 License.
+    - `README.md`: Current file.
+    - `setup.py`: The setup script managing building, distributing, and installing _taipy-core_.
+- `tests/`:
+  - `core/`: Unit tests following the `taipy/core/` structure.

+ 18 - 10
taipy/gui/INSTALLATION.md

@@ -32,13 +32,16 @@ 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
+### 1 - Clone the Taipy repository
 
-Clone the repository using the following command:
+Clone the Taipy repository using the following command:
 ```bash
-git clone https://github.com/Avaiga/taipy-gui.git
+git clone https://github.com/Avaiga/taipy.git
 ```
 
+This creates the 'taipy' directory holding all the package's source code, and the 'taipy-gui'
+source code is in the 'taipy/gui' directory.
+
 ### 2 - Install Node.js
 
 Taipy GUI has some code dealing with the client side of the web applications.
@@ -89,7 +92,7 @@ This should install the dev version of Taipy GUI as editable. You are now ready
 
 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
 ```
 
@@ -117,12 +120,17 @@ TypeScript code from your debugger.
 
 ## Running the tests
 
-To run the tests on the package, you need to create a virtual
-environment and install the development packages:
+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.
 
-Here are the commands to issue:
+```bash
+$ pip install pipenv
+$ pipenv install --dev
+```
+
+Then you can run _taipy-gui_ tests with the following command:
 
-```console
-pipenv install --dev
-pipenv run pytest
+```bash
+$ pipenv run pytest tests/gui
 ```

+ 2 - 9
taipy/gui/README.md

@@ -1,10 +1,3 @@
-# 🚧 Under construction 🚧
-
-WARNING: The Taipy team is performing a repository restructuration. This current repository taipy-gui is about to be
-merged into the main repository: taipy. Once the merge is done, the current code base will be in the
-[taipy repository](https://github.com/Avaiga/taipy). The migration should take a maximum of a few days.
-<be>
-
 # Taipy GUI
 
 ## License
@@ -33,7 +26,7 @@ Taipy is a Python library for creating Business Applications. More information o
 [website](https://www.taipy.io). Taipy is split into multiple repositories including `taipy-gui` to let users
 install the minimum they need.
 
-[Taipy GUI](https://github.com/Avaiga/taipy-gui) provides Python classes that make it easy to create powerful web apps in minutes.
+Taipy GUI provides Python classes that make it easy to create powerful web apps in minutes.
 
 A more in depth documentation of Taipy can be found [here](https://docs.taipy.io/).
 
@@ -53,7 +46,7 @@ Want to be part of the *Taipy GUI* community? Check out our [`CODE_OF_CONDUCT.md
 
 - `frontend/taipy-gui`: Graphical user interface related files;
 - `taipy/gui`: Python source files;
-- `tests/taipy/gui`: Unit tests;
+- `tests/gui`: Unit tests;
 - `tools`: Files used to document `taipy-gui`;
 - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of `taipy-gui`;
 - `CONTRIBUTING.md`: Instructions to contribute to `taipy-gui`;

+ 48 - 25
taipy/rest/INSTALLATION.md

@@ -1,22 +1,32 @@
-# Installation, Configuration and Run
+# Installation
 
-## Installation
-1. Clone the taipy rest repository
+The latest stable version of _taipy-rest_ is available through _pip_:
+```bash
+pip install taipy-rest
 ```
-$ git clone https://github.com/Avaiga/taipy-rest
-```
-2. Enter taipy rest directory
 
-```
-$ cd taipy-rest
-```
+## Development version
 
-3. Install dependencies
+You can install the development version of _taipy-rest_ with _pip_ and _git_ via the taipy repository:
+```bash
+$ pip install git+https://git@github.com/Avaiga/taipy
 ```
-$ pip install pipenv && pipenv install
+
+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
 ```
 
-## Configuration
+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:
@@ -25,25 +35,36 @@ configuration needs to be passed to the application at runtime. The following va
 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 the application you can either run locally with:
+# Running
+
+To run taipy-rest, 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
 ```
+
+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
+## 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
@@ -52,10 +73,11 @@ 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
+## 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
 ```
@@ -64,33 +86,34 @@ 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
+## 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).
 
 Log in to Container Registry:
 
-```
+```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
+# 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

+ 21 - 22
taipy/rest/README.md

@@ -1,7 +1,4 @@
 # Taipy-REST
-[![Python](https://img.shields.io/pypi/pyversions/taipy-rest)](https://pypi.org/project/taipy-rest)
-[![PyPI](https://img.shields.io/pypi/v/taipy-rest.svg?label=pip&logo=PyPI&logoColor=white)](https://pypi.org/project/taipy-rest)
-
 
 ## License
 Copyright 2021-2024 Avaiga Private Limited
@@ -32,11 +29,11 @@ Taipy is a Python library for creating Business Applications. More information o
 [website](https://www.taipy.io). Taipy is split into multiple repositories including
 _taipy-core_ and _taipy-rest_ to let users install the minimum they need.
 
-[Taipy Core](https://github.com/Avaiga/taipy-core) mostly includes business-oriented
+Taipy Core mostly includes business-oriented
 features. It helps users create and manage business applications and improve analyses
 capability through time, conditions and hypothesis.
 
-[Taipy REST](https://github.com/Avaiga/taipy-rest) is a set of APIs built on top of the
+Taipy REST is a set of APIs built on top of the
 _taipy-core_ library developed by Avaiga. This project is meant to be used as a complement
 for **taipy** and its goal is to enable automation through rest APIs of processes built
 on taipy.
@@ -66,23 +63,25 @@ Want to be part of the _Taipy REST_ community? Check out our
 
 ## Directory Structure
 
-- `taipy/rest`: Main source code folder.
-    - `api`: Endpoints and schema definitions.
-      - `resources`: Implementation of all endpoints related to taipy.
-      - `schemas`: Schemas related to taipy objects. Used for marshalling and unmarshalling data.
-      - `views`: Mapping of resources to urls
-    - `commons`: Common files shared throughout the application
-      - `templates`: Swagger and redoc templates for generating the documentation
+- `taipy/`:
+  - `rest/`:
+    - `api/`: Endpoints and schema definitions.
+      - `resources/`: Implementation of all endpoints related to taipy.
+      - `schemas/`: Schemas related to taipy objects. Used for marshalling and unmarshalling data.
+      - `views.py`: Mapping of resources to urls
+    - `commons/`: Common files shared throughout the application
+      - `templates/`: Swagger and redoc templates for generating the documentation
     - `app.py`: Flask app configuration and creation
     - `extensions.py`: Singletons used on the application factory
     - `rest.py`: Main python entrypoint for running _taipy-rest_ application.
-- `tests`: Unit tests.
-- `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-rest_.
-- `CONTRIBUTING.md`: Instructions to contribute to _taipy-rest_.
-- `INSTALLATION.md`: Instructions to install _taipy-rest_.
-- `LICENSE`: The Apache 2.0 License.
-- `Pipfile`: File used by the Pipenv virtual environment to manage project dependencies.
-- `README.md`: Current file.
-- `contributors.txt`: The list of contributors
-- `setup.py`: The setup script managing building, distributing, and installing _taipy-rest_.
-- `tox.ini`: Contains test scenarios to be run.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-rest_.
+    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-rest_.
+    - `INSTALLATION.md`: Instructions to install _taipy-rest_.
+    - `LICENSE`: The Apache 2.0 License.
+    - `Pipfile`: File used by the Pipenv virtual environment to manage project dependencies.
+    - `README.md`: Current file.
+    - `contributors.txt`: The list of contributors
+    - `setup.py`: The setup script managing building, distributing, and installing _taipy-rest_.
+    - `tox.ini`: Contains test scenarios to be run.
+- `tests/`:
+  - `rest/`: Unit tests following the `taipy/rest/` structure.

+ 16 - 9
taipy/templates/README.md

@@ -16,7 +16,7 @@ and limitations under the License.
   - [Taipy](#taipy)
   - [License](#license)
   - [Usage](#usage)
-  - [What is Taipy](#what-is-taipy)
+  - [What is Taipy templates](#what-is-taipy-templates)
   - [Contributing](#contributing)
   - [Code of conduct](#code-of-conduct)
   - [Directory Structure](#directory-structure)
@@ -33,11 +33,11 @@ A more in depth documentation of taipy can be found [here](https://docs.taipy.io
 
 To create a Taipy application using this template, first you need to install Taipy (> 2.2).
 Then from a terminal, run the following command.
-```
+```bash
 $ taipy create
 ```
 or
-```
+```bash
 $ taipy create --template "default"
 ```
 
@@ -55,9 +55,16 @@ Want to be part of the _Taipy_ community? Check out our
 
 ## Directory Structure
 
-- `taipy/templates/`: Contains each template in a dedicated sub-folder with the
-    following structure:
-- `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy_.
-- `CONTRIBUTING.md`: Instructions to contribute to _taipy_.
-- `LICENSE`: The Apache 2.0 License.
-- `README.md`: Current file.
+- `taipy/`:
+  - `templates/`: Contains templates, each in a dedicated sub-folder with the following structure:
+    - `<template-name>/`: Internal package for Taipy data backup mechanism.
+      - `{{cookiecutter.__root_folder_name}}/`: The root folder of the application created using this template.
+      - `hooks/`: Contains hooks to be executed before and after the application is created.
+      - `cookiecutter.json`: The configuration file for the template.
+    - `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy-templates_.
+    - `CONTRIBUTING.md`: Instructions to contribute to _taipy-templates_.
+    - `LICENSE`: The Apache 2.0 License.
+    - `README.md`: Current file.
+    - `setup.py`: The setup script managing building, distributing, and installing _taipy-templates_.
+- `tests/`:
+  - `templates/`: Unit tests following the `taipy/templates/` structure.