Kaynağa Gözat

fix: remove $ from bash example to allow the user to copy the commands

trgiangdo 1 yıl önce
ebeveyn
işleme
e47c7bf57c

+ 2 - 2
CONTRIBUTING.md

@@ -98,8 +98,8 @@ working on it.
    code format or Python typing.
    code format or Python typing.
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
-   $ pipenv install pre-commit
-   $ pipenv run python -m pre-commit install
+   pipenv install pre-commit
+   pipenv run python -m pre-commit install
    ```
    ```
 
 
 4. Make the changes.<br/>
 4. Make the changes.<br/>

+ 17 - 17
INSTALLATION.md

@@ -14,12 +14,12 @@ The easiest way to install Taipy is from the
 
 
 Run the command:
 Run the command:
 ```bash
 ```bash
-$ pip install taipy
+pip install taipy
 ```
 ```
 
 
 If you are running in a virtual environment, you will have to issue the command:
 If you are running in a virtual environment, you will have to issue the command:
 ```bash
 ```bash
-$ pipenv install taipy
+pipenv install taipy
 ```
 ```
 
 
 These commands install the `taipy` package in the Python environment with all its
 These commands install the `taipy` package in the Python environment with all its
@@ -33,7 +33,7 @@ contributors whom we praise for their input.
 The development version of Taipy can be installed using *pip* and *git*:
 The development version of Taipy can be installed using *pip* and *git*:
 
 
 ```bash
 ```bash
-$ pip install git+https://git@github.com/Avaiga/taipy
+pip install git+https://git@github.com/Avaiga/taipy
 ```
 ```
 
 
 ## Installing for development
 ## Installing for development
@@ -42,7 +42,7 @@ If you need the source code for Taipy on your system so you can see how things a
 participate in the improvement of the packages, you can clone the GitHub repository:
 participate in the improvement of the packages, you can clone the GitHub repository:
 
 
 ```bash
 ```bash
-$ git clone https://github.com/Avaiga/taipy.git
+git clone https://github.com/Avaiga/taipy.git
 ```
 ```
 
 
 This creates the 'taipy' directory holding all the package's source code.
 This creates the 'taipy' directory holding all the package's source code.
@@ -76,17 +76,17 @@ Here is the sequence of commands that can be issued to build both sets of files:
 # Current directory is the repository's root directory
 # Current directory is the repository's root directory
 #
 #
 # Build the Taipy GUI bundle
 # Build the Taipy GUI bundle
-$ cd frontend/taipy-gui
-$ cd dom
-$ npm i
-$ cd ..
-$ npm i --omit=optional
-$ npm run build
+cd frontend/taipy-gui
+cd dom
+npm i
+cd ..
+npm i --omit=optional
+npm run build
 #
 #
 # Build the Taipy front-end bundle
 # Build the Taipy front-end bundle
-$ cd ../taipy # Current directory is [taipy-dir]/frontend/taipy
-$ npm i
-$ npm run build
+cd ../taipy # Current directory is [taipy-dir]/frontend/taipy
+npm i
+npm run build
 ```
 ```
 
 
 These commands should create the directories `taipy/gui/webapp` and `taipy/gui_core/lib` in the
 These commands should create the directories `taipy/gui/webapp` and `taipy/gui_core/lib` in the
@@ -97,7 +97,7 @@ root directory of the taipy repository.
 If you plan to modify the front-end code and need to debug the TypeScript
 If you plan to modify the front-end code and need to debug the TypeScript
 code, you must use the following:
 code, you must use the following:
 ```bash
 ```bash
-$ npm run build:dev
+npm run build:dev
 ```
 ```
 
 
 instead of the *standard* build option.
 instead of the *standard* build option.
@@ -129,12 +129,12 @@ We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtu
 and install the development packages.
 and install the development packages.
 
 
 ```bash
 ```bash
-$ pip install pipenv
-$ pipenv install --dev
+pip install pipenv
+pipenv install --dev
 ```
 ```
 
 
 Then you can run the tests with the following command:
 Then you can run the tests with the following command:
 
 
 ```bash
 ```bash
-$ pipenv run pytest
+pipenv run pytest
 ```
 ```

+ 1 - 1
README.md

@@ -60,7 +60,7 @@ Taipy is designed for data scientists and machine learning engineers to build fu
 ## ⚙️ Quickstart
 ## ⚙️ Quickstart
 To install Taipy stable release run:
 To install Taipy stable release run:
 ```bash
 ```bash
-$ pip install taipy
+pip install taipy
 ```
 ```
 
 
 To install Taipy on a Conda Environment or from source, please refer to the [Installation Guide](https://docs.taipy.io/en/latest/installation/).<br />
 To install Taipy on a Conda Environment or from source, please refer to the [Installation Guide](https://docs.taipy.io/en/latest/installation/).<br />

+ 5 - 5
doc/gui/extension/README.md

@@ -149,13 +149,13 @@ the "TAIPY_DIR" variable is set, we can build the JavaScript module file:
 - Install the Taipy GUI JavaScript bundle and the other dependencies:<br/>
 - Install the Taipy GUI JavaScript bundle and the other dependencies:<br/>
   You must run the command:
   You must run the command:
   ```bash
   ```bash
-  $ npm install
+  npm install
   ```
   ```
   This command will fail with a message indicating that the Taipy GUI 'webapp' directory
   This command will fail with a message indicating that the Taipy GUI 'webapp' directory
   could not be found if the "TAIPY_DIR" environment variable was not set properly.
   could not be found if the "TAIPY_DIR" environment variable was not set properly.
 - You can now build the custom element library JavaScript bundle file:
 - You can now build the custom element library JavaScript bundle file:
   ```bash
   ```bash
-  $ npm run build
+  npm run build
   ```
   ```
   This generates the bundle `exampleLibrary.js` in the `dist` directory (if you have not
   This generates the bundle `exampleLibrary.js` in the `dist` directory (if you have not
   changed the `output` settings in `webpack.config.js`). This file contains the definition
   changed the `output` settings in `webpack.config.js`). This file contains the definition
@@ -169,7 +169,7 @@ elements defined by this extension library example.
 
 
 To execute this application, you can run:
 To execute this application, you can run:
 ```bash
 ```bash
-$ python main.py
+python main.py
 ```
 ```
 (prefixed by `pipenv run` if you are using `pipenv`)
 (prefixed by `pipenv run` if you are using `pipenv`)
 
 
@@ -181,12 +181,12 @@ The following two simple steps must be performed:
 
 
 - Install the build package:
 - Install the build package:
   ```bash
   ```bash
-  $ pip install build
+  pip install build
   ```
   ```
   (prefixed by `pipenv run` if you are using `pipenv`)
   (prefixed by `pipenv run` if you are using `pipenv`)
 - Build the package:
 - Build the package:
   ```bash
   ```bash
-  $ python -m build
+  python -m build
   ```
   ```
   (prefixed by `pipenv run` if you are using `pipenv`)
   (prefixed by `pipenv run` if you are using `pipenv`)
 
 

+ 5 - 5
frontend/taipy-gui/README.md

@@ -20,13 +20,13 @@ run the following commands:
 #   [taipy-dir]/frontend/taipy-gui
 #   [taipy-dir]/frontend/taipy-gui
 #
 #
 # Install the DOM dependencies (once and for all)
 # Install the DOM dependencies (once and for all)
-$ cd dom
-$ npm i
-$ cd ..
+cd dom
+npm i
+cd ..
 # Install the web app dependencies
 # Install the web app dependencies
-$ npm i --omit=optional
+npm i --omit=optional
 # Build the web app and all elements
 # Build the web app and all elements
-$ npm run build
+npm run build
 ```
 ```
 
 
 
 

+ 1 - 1
frontend/taipy-gui/extension-index.md

@@ -27,7 +27,7 @@ The Extension API is located by the 'taipy-gui' module.
 In order to import items from this module, you have to install it, using `npm`.
 In order to import items from this module, you have to install it, using `npm`.
 The most simple way to install the Taipy GUI Extension module is:
 The most simple way to install the Taipy GUI Extension module is:
 ```bash
 ```bash
-$ npm i <TAIPY_DIR>/taipy/gui/webapp
+npm i <TAIPY_DIR>/taipy/gui/webapp
 ```
 ```
 
 
 Where *<TAIPY_DIR>* represents the directory where, in the development machine's
 Where *<TAIPY_DIR>* represents the directory where, in the development machine's

+ 2 - 2
frontend/taipy/README.md

@@ -17,9 +17,9 @@ run the following commands:
 # Current directory is the directory where this README file is located:
 # Current directory is the directory where this README file is located:
 #   [taipy-dir]/frontend/taipy
 #   [taipy-dir]/frontend/taipy
 #
 #
-$ npm i
+npm i
 # Build the Taipy front-end bundle
 # Build the Taipy front-end bundle
-$ npm run build
+npm run build
 ```
 ```
 
 
 After these commands are successfully executed, a new directory will be created in
 After these commands are successfully executed, a new directory will be created in

+ 2 - 2
taipy/config/CONTRIBUTING.md

@@ -98,8 +98,8 @@ working on it.
    code format or Python typing.<br/>
    code format or Python typing.<br/>
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
-   $ pipenv install pre-commit
-   $ pipenv run python -m pre-commit install
+   pipenv install pre-commit
+   pipenv run python -m pre-commit install
    ```
    ```
 
 
 4. Make the changes.<br/>
 4. Make the changes.<br/>

+ 6 - 6
taipy/config/INSTALLATION.md

@@ -2,14 +2,14 @@
 
 
 The latest stable version of *taipy-config* can be installed using `pip`:
 The latest stable version of *taipy-config* can be installed using `pip`:
 ```bash
 ```bash
-$ pip install taipy-config
+pip install taipy-config
 ```
 ```
 
 
 ## Development version
 ## Development version
 
 
 You can install the development version of *taipy-config* with `pip` and `git` directly from the Taipy repository:
 You can install the development version of *taipy-config* with `pip` and `git` directly from the Taipy repository:
 ```bash
 ```bash
-$ pip install git+https://git@github.com/Avaiga/taipy
+pip install git+https://git@github.com/Avaiga/taipy
 ```
 ```
 
 
 This command installs the development version of _taipy_ package in the Python environment with all
 This command installs the development version of _taipy_ package in the Python environment with all
@@ -19,7 +19,7 @@ If you need the source code for _taipy-config_ on your system so you can see how
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 
 
 ```bash
 ```bash
-$ git clone https://github.com/Avaiga/taipy.git
+git clone https://github.com/Avaiga/taipy.git
 ```
 ```
 
 
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-config'
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-config'
@@ -32,12 +32,12 @@ We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtu
 and install the development packages.
 and install the development packages.
 
 
 ```bash
 ```bash
-$ pip install pipenv
-$ pipenv install --dev
+pip install pipenv
+pipenv install --dev
 ```
 ```
 
 
 Then you can run *taipy-config* tests with the following command:
 Then you can run *taipy-config* tests with the following command:
 
 
 ```bash
 ```bash
-$ pipenv run pytest tests/config
+pipenv run pytest tests/config
 ```
 ```

+ 2 - 2
taipy/core/CONTRIBUTING.md

@@ -98,8 +98,8 @@ working on it.
    code format or Python typing.
    code format or Python typing.
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
-   $ pipenv install pre-commit
-   $ pipenv run python -m pre-commit install
+   pipenv install pre-commit
+   pipenv run python -m pre-commit install
    ```
    ```
 
 
 4. Make the changes.<br/>
 4. Make the changes.<br/>

+ 5 - 5
taipy/core/INSTALLATION.md

@@ -9,7 +9,7 @@ pip install taipy-core
 
 
 You can install the development version of _taipy-core_ with _pip_ and _git_ via the taipy repository:
 You can install the development version of _taipy-core_ with _pip_ and _git_ via the taipy repository:
 ```bash
 ```bash
-$ pip install git+https://git@github.com/Avaiga/taipy
+pip install git+https://git@github.com/Avaiga/taipy
 ```
 ```
 
 
 This command installs the development version of _taipy_ package in the Python environment with all
 This command installs the development version of _taipy_ package in the Python environment with all
@@ -19,7 +19,7 @@ If you need the source code for _taipy-core_ on your system so you can see how t
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 
 
 ```bash
 ```bash
-$ git clone https://github.com/Avaiga/taipy.git
+git clone https://github.com/Avaiga/taipy.git
 ```
 ```
 
 
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-core'
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-core'
@@ -32,12 +32,12 @@ We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtu
 and install the development packages.
 and install the development packages.
 
 
 ```bash
 ```bash
-$ pip install pipenv
-$ pipenv install --dev
+pip install pipenv
+pipenv install --dev
 ```
 ```
 
 
 Then you can run _taipy-core_ tests with the following command:
 Then you can run _taipy-core_ tests with the following command:
 
 
 ```bash
 ```bash
-$ pipenv run pytest tests/core
+pipenv run pytest tests/core
 ```
 ```

+ 2 - 2
taipy/gui/CONTRIBUTING.md

@@ -98,8 +98,8 @@ working on it.
    code format or Python typing.
    code format or Python typing.
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
-   $ pipenv install pre-commit
-   $ pipenv run python -m pre-commit install
+   pipenv install pre-commit
+   pipenv run python -m pre-commit install
    ```
    ```
 
 
 4. Make the changes.<br/>
 4. Make the changes.<br/>

+ 13 - 13
taipy/gui/INSTALLATION.md

@@ -22,7 +22,7 @@ The easiest way to install Taipy GUI is using pip
 
 
 Run the command:
 Run the command:
 ```bash
 ```bash
-$ pip install taipy-gui
+pip install taipy-gui
 ```
 ```
 
 
 ## Installing the development version
 ## Installing the development version
@@ -36,7 +36,7 @@ You should also install this version if you want to contribute to the developmen
 
 
 Clone the Taipy repository using the following command:
 Clone the Taipy repository using the following command:
 ```bash
 ```bash
-$ git clone https://github.com/Avaiga/taipy.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'
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-gui'
@@ -62,18 +62,18 @@ Open a new terminal and run the following commands:
 
 
 - Install the DOM dependencies
 - Install the DOM dependencies
 ```bash
 ```bash
-$ cd gui
-$ cd dom
-$ npm i
+cd gui
+cd dom
+npm i
 ```
 ```
 - Install the web app dependencies
 - Install the web app dependencies
 ```bash
 ```bash
-$ cd ..
-$ npm i --omit=optional
+cd ..
+npm i --omit=optional
 ```
 ```
 - Build the web app
 - Build the web app
 ```bash
 ```bash
-$ npm run build
+npm run build
 ```
 ```
 
 
 After a few minutes, this creates the directory `taipy/gui/webapp` in the root directory of the repository
 After a few minutes, this creates the directory `taipy/gui/webapp` in the root directory of the repository
@@ -83,7 +83,7 @@ where the front-end code for Taipy GUI is split into a set of JavaScript bundles
 
 
 In a terminal, **at the root of the repository**, run:
 In a terminal, **at the root of the repository**, run:
 ```bash
 ```bash
-$ pip install -e . --user
+pip install -e . --user
 ```
 ```
 
 
 This should install the dev version of Taipy GUI as editable. You are now ready to use it.
 This should install the dev version of Taipy GUI as editable. You are now ready to use it.
@@ -93,7 +93,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
 If you plan to modify the front-end code and need to debug the TypeScript
 code, you must use the following:
 code, you must use the following:
 ```bash
 ```bash
-$ npm run build:dev
+npm run build:dev
 ```
 ```
 
 
 instead of the *standard* build option.
 instead of the *standard* build option.
@@ -125,12 +125,12 @@ We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtu
 and install the development packages.
 and install the development packages.
 
 
 ```bash
 ```bash
-$ pip install pipenv
-$ pipenv install --dev
+pip install pipenv
+pipenv install --dev
 ```
 ```
 
 
 Then you can run _taipy-gui_ tests with the following command:
 Then you can run _taipy-gui_ tests with the following command:
 
 
 ```bash
 ```bash
-$ pipenv run pytest tests/gui
+pipenv run pytest tests/gui
 ```
 ```

+ 2 - 2
taipy/rest/CONTRIBUTING.md

@@ -98,8 +98,8 @@ working on it.
    code format or Python typing.
    code format or Python typing.
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
-   $ pipenv install pre-commit
-   $ pipenv run python -m pre-commit install
+   pipenv install pre-commit
+   pipenv run python -m pre-commit install
    ```
    ```
 
 
 4. Make the changes.<br/>
 4. Make the changes.<br/>

+ 14 - 14
taipy/rest/INSTALLATION.md

@@ -9,7 +9,7 @@ pip install taipy-rest
 
 
 You can install the development version of _taipy-rest_ with _pip_ and _git_ via the taipy repository:
 You can install the development version of _taipy-rest_ with _pip_ and _git_ via the taipy repository:
 ```bash
 ```bash
-$ pip install git+https://git@github.com/Avaiga/taipy
+pip install git+https://git@github.com/Avaiga/taipy
 ```
 ```
 
 
 This command installs the development version of _taipy_ package in the Python environment with all
 This command installs the development version of _taipy_ package in the Python environment with all
@@ -19,7 +19,7 @@ If you need the source code for _taipy-rest_ on your system so you can see how t
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 maybe participate in the improvement of the packages, you can clone the GitHub repository:
 
 
 ```bash
 ```bash
-$ git clone https://github.com/Avaiga/taipy.git
+git clone https://github.com/Avaiga/taipy.git
 ```
 ```
 
 
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-rest'
 This creates the 'taipy' directory holding all the package's source code, and the 'taipy-rest'
@@ -42,18 +42,18 @@ We recommend using [Pipenv](https://pipenv.pypa.io/en/latest/) to create a virtu
 and install the development packages.
 and install the development packages.
 
 
 ```bash
 ```bash
-$ pip install pipenv
-$ pipenv install --dev
+pip install pipenv
+pipenv install --dev
 ```
 ```
 
 
 To run the application you can either run locally with:
 To run the application you can either run locally with:
 ```bash
 ```bash
-$ flask run
+flask run
 ```
 ```
 
 
 or it can be run inside Docker with:
 or it can be run inside Docker with:
 ```bash
 ```bash
-$ docker-compose up
+docker-compose up
 ```
 ```
 
 
 You can also run with a Gunicorn or wsgi server.
 You can also run with a Gunicorn or wsgi server.
@@ -65,9 +65,9 @@ This project provide a simple wsgi entry point to run gunicorn or uwsgi for exam
 For gunicorn you only need to run the following commands
 For gunicorn you only need to run the following commands
 
 
 ```bash
 ```bash
-$ pip install gunicorn
+pip install gunicorn
 
 
-$ gunicorn myapi.wsgi:app
+gunicorn myapi.wsgi:app
 ```
 ```
 And that's it ! Gunicorn is running on port 8000
 And that's it ! Gunicorn is running on port 8000
 
 
@@ -78,8 +78,8 @@ If you chose gunicorn as your wsgi server, the proper commands should be in your
 Pretty much the same as gunicorn here
 Pretty much the same as gunicorn here
 
 
 ```bash
 ```bash
-$ pip install uwsgi
-$ uwsgi --http 127.0.0.1:5000 --module myapi.wsgi:app
+pip install uwsgi
+uwsgi --http 127.0.0.1:5000 --module myapi.wsgi:app
 ```
 ```
 
 
 And that's it ! Uwsgi is running on port 5000
 And that's it ! Uwsgi is running on port 5000
@@ -93,22 +93,22 @@ Make sure you have a working Docker installation (e.g. docker ps) and that you
 Log in to Container Registry:
 Log in to Container Registry:
 
 
 ```bash
 ```bash
-$ heroku container:login
+heroku container:login
 ```
 ```
 
 
 Create a heroku app
 Create a heroku app
 ```bash
 ```bash
-$ heroku create
+heroku create
 ```
 ```
 
 
 Build the image and push to Container Registry:
 Build the image and push to Container Registry:
 ```bash
 ```bash
-$ heroku container:push web
+heroku container:push web
 ```
 ```
 
 
 Then release the image:
 Then release the image:
 ```bash
 ```bash
-$ heroku container:release web
+heroku container:release web
 ```
 ```
 
 
 You can now access **taipy rest** on the URL that was returned on the `heroku create` command.
 You can now access **taipy rest** on the URL that was returned on the `heroku create` command.

+ 2 - 2
taipy/templates/CONTRIBUTING.md

@@ -98,8 +98,8 @@ working on it.
    code format or Python typing.
    code format or Python typing.
    You can install and setup it up by doing:
    You can install and setup it up by doing:
    ```bash
    ```bash
-   $ pipenv install pre-commit
-   $ pipenv run python -m pre-commit install
+   pipenv install pre-commit
+   pipenv run python -m pre-commit install
    ```
    ```
 
 
 4. Make the changes.<br/>
 4. Make the changes.<br/>

+ 2 - 2
taipy/templates/README.md

@@ -34,11 +34,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).
 To create a Taipy application using this template, first you need to install Taipy (> 2.2).
 Then from a terminal, run the following command.
 Then from a terminal, run the following command.
 ```bash
 ```bash
-$ taipy create
+taipy create
 ```
 ```
 or
 or
 ```bash
 ```bash
-$ taipy create --template "default"
+taipy create --template "default"
 ```
 ```
 
 
 After providing necessary information, your new application is created in the current
 After providing necessary information, your new application is created in the current