浏览代码

README.md update (#120)

* README.md update
Marine Gosselin 2 年之前
父节点
当前提交
603b8e7ab1
共有 9 个文件被更改,包括 222 次插入49 次删除
  1. 0 13
      INSTALLATION.md
  2. 222 36
      README.md
  3. 二进制
      readme_img/readme_app.gif
  4. 二进制
      readme_img/readme_core_intro.gif
  5. 二进制
      readme_img/readme_exec_g.png
  6. 二进制
      readme_img/readme_gui_app.gif
  7. 二进制
      readme_img/readme_gui_intro.gif
  8. 二进制
      readme_img/readme_logo.png
  9. 二进制
      readme_img/readme_studio.gif

+ 0 - 13
INSTALLATION.md

@@ -1,13 +0,0 @@
-# Installation
-
-The latest stable version of _taipy_ is available through _pip_:
-```
-pip install taipy
-```
-
-## Development version
-
-You can install the development version of _taipy_ with _pip_ and _git_:
-```
-pip install git+https://git@github.com/Avaiga/taipy
-```

+ 222 - 36
README.md

@@ -1,40 +1,226 @@
-# Taipy
-[![tests](https://github.com/Avaiga/taipy/actions/workflows/tests.yml/badge.svg)](https://github.com/Avaiga/taipy/actions/workflows/tests.yml)
-[![Python](https://img.shields.io/pypi/pyversions/taipy)](https://pypi.org/project/taipy)
-[![PyPI](https://img.shields.io/pypi/v/taipy.svg?label=pip&logo=PyPI&logoColor=white)](https://pypi.org/project/taipy)
+<br>
+<br>
 
-## License
-Copyright 2023 Avaiga Private Limited
+<img align="left" src="readme_img/readme_logo.png" alt="Taipy Logo" width="150" height="150" ></img>
+<br>
+#  Welcome to Taipy 
+<p align="left">
+    <a href="https://pypi.python.org/pypi/taipy/" alt="Taipy version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/taipy.svg?label=pip&logo=PyPI&color=ff462b&labelColor=283282"></a>
+    <a href="https://pypi.org/project/taipy" alt="Python version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/pyversions/taipy?color=ff462b&labelColor=283282"></a>
+    <a href="https://www.youtube.com/@taipy8009" alt="YouTube">
+        <img src="https://img.shields.io/badge/youtube-click_to_watch_videos-red.svg?color=ff462b&labelColor=283282&logo=youtube" /></a>
+     <a href="https://twitter.com/Taipy_io" alt="Twitter">
+        <img src="https://img.shields.io/badge/twitter-click_for_tweets-red.svg?color=ff462b&labelColor=283282&logo=twitter" /></a>
+    <a href="https://github.com/Avaiga/taipy/actions/workflows/tests.yml" alt="tests">
+        <img alt="PyPI" src="https://github.com/Avaiga/taipy/actions/workflows/tests.yml/badge.svg"></a>
 
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
-the License. You may obtain a copy of the License at
-[http://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
 
-Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
-an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
-specific language governing permissions and limitations under the License.
+<br>
+
+###  <div align="left">Turns Data and AI algorithms into full web applications in no time. 
+###  How? Taipy GUI with Taipy Core pops out as a 360° platform to build production-ready web applications</div>  
+
+ 
+
+<br>
+<br>
 
-## Usage
-  - [Taipy](#taipy)
-  - [License](#license)
-  - [Usage](#usage)
-  - [What is Taipy](#what-is-taipy)
-  - [Installation](#installation)
-  - [Contributing](#contributing)
-  - [Code of conduct](#code-of-conduct)
-  - [Directory Structure](#directory-structure)
-## What is Taipy
+###  <div align="left">*Open Source, 100% Python*</div>
 
-Taipy is a Python library for creating Business Applications. More information on our [website](https://www.taipy.io).
-Taipy is split into multiple repositories to let users install the minimum they need.
 
-A more in depth documentation of taipy can be found [here](https://docs.taipy.io).
+<br>
+<br>
+<br>
+
+#  <div align="center"> 📊 We make both ends meet ⚙️ </div>  
+<br>
+ <div align="center">
+    
+| TAIPY GUI - the frond-end  | TAIPY Core - the back-end |
+| --------  | -------- |
+|<img src="readme_img/readme_gui_intro.gif" alt="Taipy Logo"  width="350" height="300"/> | <img src="readme_img/readme_core_intro.gif" alt="Taipy Logo"  width="350" height="300"/>
+
+    
+</div> 
+
+<br>
+<br>
 
 ## Installation
 
-Want to install _Taipy_? Check out our [`INSTALLATION.md`](INSTALLATION.md) file.
+Open a terminal and run:
+
+```bash
+$ pip install taipy
+```
+
+*You're all set! All aboard the Taipy journey 🚂*
+
+<br>
+
+## Ready, Set, GUI
+
+### Tiny Taipy GUI Demo
+
+```python
+excitement_page="""
+# Welcome to Taipy
+## Getting started with Taipy GUI
+### How excited are you to try Taipy?
+
+<|{excitement}|slider|min=1|max=100|>
+
+My excitement level: <|{excitement}|text|>
+"""
+excitement=100
+
+Gui(page=my_page).run()
+```
+*RUN*🏃🏽‍♀️  
+<div align="center">🎊 TA-DA! 🎊</div>  
+<br>
+<div align="center"><img src="readme_img/readme_gui_app.gif" width=600 height=400 alt="GUI demo"></img></div>  
+
+<br>
+<br>
+
+### <div align="center">*Find out more*</div>
+*<div align="center">Check out our [Getting Started](https://docs.taipy.io/en/latest/getting_started/getting-started-gui/) and [Documentation](https://docs.taipy.io/en/latest/manuals/gui/)</div>*
+
+<br>
+<br>
+
+## EN-CORE?
+
+#### <div align="center">Let's create a back-end execution, also called *scenario* using Taipy Core. Our scenario will filter movie data based on the genre you choose. This scenario will be submitted (i.e., executed) each time the genre selection changes and output the seven most popular movies of that genre. </div>  
+<br>
+
+*Here is our filter function: a standard Python function that is used by the unique task in the scenario*
+```python
+def filter_genre(initial_dataset: pd.DataFrame, selected_genre):
+    filtered_dataset = initial_dataset[initial_dataset['genres'].str.contains(selected_genre)]
+    filtered_data = filtered_dataset.nlargest(7, 'Popularity %')
+    return filtered_data
+```
+
+*This is the execution graph of the scenario we are implementing*
+
+<div align="center"><img src="readme_img/readme_exec_g.png" alt="Taipy Logo"  width="400" height="300"/></div> 
+
+
+### Taipy Studio - The easy peasy way
+*You can use the Taipy Studio extension in VSCode to configure your pipeline with no code* 
+
+<div align="center"><img src="readme_img/readme_studio.gif" width=600 height=400 alt="GUI demo"></img></div> 
+
+*Your configuration is automatically saved as a TOML file* 
+
+<br>
+<br>
+
+### <div align="center">*Find out more*</div>
+*<div align="center">Check out our [Getting Started](https://docs.taipy.io/en/latest/getting_started/getting-started-core/) and [Documentation](https://docs.taipy.io/en/latest/manuals/studio/) </div>*
+
+<br>
+<br>
+<br>
+<br>
 
-## Contributing
+### Taipy Core - a walk on the code side
+<div align="left">For more advanced use cases or if you prefer coding your configurations instead of using Taipy Studio, Taipy has your back! </div>   
+
+*<div align="left">Check out the movie genre demo scenario creation with this [Demo](https://www.taipy.io/project/movie-genre-selector/) </div>*
+
+<br>
+<br>
+<br>
+
+### <div align="center">*Find out more*</div>
+*<div align="center">Check out our [Getting Started](https://docs.taipy.io/en/latest/getting_started/getting-started-core/) and [Documentation](https://docs.taipy.io/en/latest/manuals/core/) </div>*
+
+<br>
+<br>
+<br>
+
+
+## Front-end ➕ Back-end
+*Now, let's load this configuration and add a user interface on top for a 🎉FULL APPLICATION🎉*
+```python
+import taipy as tp
+import pandas as pd
+from taipy import Config, Scope, Gui
+
+# TAIPY Core
+
+# Filtering function - task
+def filter_genre(initial_dataset: pd.DataFrame, selected_genre):
+    filtered_dataset = initial_dataset[initial_dataset['genres'].str.contains(selected_genre)]
+    filtered_data = filtered_dataset.nlargest(7, 'Popularity %')
+    return filtered_data
+
+# Load the configuration made with Taipy Studio
+Config.load('config.toml')
+scenario_cfg = Config.scenarios['scenario']
+
+# Start Taipy Core service
+tp.Core().run()
+
+# Create a scenario
+scenario = tp.create_scenario(scenario_cfg)
+
+
+# TAIPY GUI
+# Let's add Taipy GUI to our Taipy Core for a full application
+
+# Callback definition - submits scenario with genre selection
+def on_genre_selected(state):
+    scenario.selected_genre_node.write(state.selected_genre)
+    tp.submit(scenario)
+    state.df = scenario.filtered_data.read()  
+
+# Get list of genres
+genres = [
+    'Action', 'Adventure', 'Animation', 'Children', 'Comedy', 'Fantasy', 'IMAX'
+    'Romance','Sci-FI', 'Western', 'Crime', 'Mystery', 'Drama', 'Horror', 'Thriller', 'Film-Noir','War', 'Musical', 'Documentary'
+    ]
+
+# Initialization of variables
+df = pd.DataFrame(columns=['Title', 'Popularity %'])
+selected_genre = None
+
+# User interface definition
+my_page = """
+# Film recommendation
+
+## Choose your favorite genre
+<|{selected_genre}|selector|lov={genres}|on_change=on_genre_selected|dropdown|>
+
+## Here are the top seven picks by popularity
+<|{df}|chart|x=Title|y=Popularity %|type=bar|title=Film Popularity|>
+"""
+
+Gui(page=my_page).run()
+
+```
+*RUN*🏃🏽‍♀️ 
+
+<br>
+
+<div align="center">🎊TA-DA!🎊</div>  
+<br>
+<div align="center"><img src="readme_img/readme_app.gif" width=700 height=500 alt="GUI demo"></img></div> 
+
+<br>
+
+<br>
+
+<br>
+<br>
+
+
+## Contributing ⚒⚒
 
 Want to help build _Taipy_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) file.
 
@@ -42,13 +228,13 @@ Want to help build _Taipy_? Check out our [`CONTRIBUTING.md`](CONTRIBUTING.md) f
 
 Want to be part of the _Taipy_ community? Check out our [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) file.
 
-## Directory Structure
+## License
+Copyright 2023 Avaiga Private Limited
 
-- `taipy`:
-    - `_run.py`: The python module exposing the method `run` to use to start a Taipy application.
-- `CODE_OF_CONDUCT.md`: Code of conduct for members and contributors of _taipy_.
-- `CONTRIBUTING.md`: Instructions to contribute to _taipy_.
-- `INSTALLATION.md`: Instructions to install _taipy_.
-- `LICENSE`: The Apache 2.0 License.
-- `README.md`: Current file.
-- `setup.py`: The setup script managing building, distributing, and installing _taipy_.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+the License. You may obtain a copy of the License at
+[http://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+specific language governing permissions and limitations under the License.

二进制
readme_img/readme_app.gif


二进制
readme_img/readme_core_intro.gif


二进制
readme_img/readme_exec_g.png


二进制
readme_img/readme_gui_app.gif


二进制
readme_img/readme_gui_intro.gif


二进制
readme_img/readme_logo.png


二进制
readme_img/readme_studio.gif