laipeng/reflex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated README and Contributing (#25)

Browse Source 
* Updated README.

Co-authored-by: Alek Petuskey
This commit is contained in:
Alek Petuskey 2022-12-04 19:51:27 -08:00 committed by GitHub
parent e636f0dd3e
commit 45a8997169
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 140 additions and 119 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CODE_OF_CONDUCT.md
View File

@ -110,7 +110,7 @@ standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals. individual, or aggression toward or disparagement of classes of individuals.
**Consequence**: A permanent ban from any sort of public interaction within **Consequence**: A permanent ban from any sort of public interaction within
the community. the community as well as any sort of private interaction with the people.
## Attribution ## Attribution

14
CONTRIBUTING.md
View File

@ -4,15 +4,21 @@
To navigate our codebase with confidence, see [Pynecone Docs](https://pynecone.io/docs/getting-started/introduction) :confetti_ball:. To navigate our codebase with confidence, see [Pynecone Docs](https://pynecone.io/docs/getting-started/introduction) :confetti_ball:.
### Discussions
- Have a question? Want to discuss a feature? [Start a discussion](https://github.com/pynecone-io/pynecone/discussions)
We welome and discussions and questions. We want to make sure that Pynecone is the best it can be, and we can't do that without your help.
### Issues ### Issues
#### Create a new issue * #### Create a new issue
If you spot a problem with anything in Pynecone feel free to create an issue. Even if you are not sure if its a problem with the framework or your own code, create an issue and we will do our best to answer or resolve it. If you spot a problem with anything in Pynecone feel free to create an issue. Even if you are not sure if its a problem with the framework or your own code, create an issue and we will do our best to answer or resolve it.
#### Solve an issue * #### Solve an issue
Scan through our [existing issues](https://github.com/pynecone-io/pynecone/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. Any large issue changing the compiler of Pynecone should brought to the Pynecone maintainers for approval Scan through our [existing issues](https://github.com/pynecone-io/pynecone/issues) to find one that interests you. You can narrow down the search using `labels` as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix. Any large issue changing the compiler of Pynecone should brought to the Pynecone maintainers for approval
Thank you for supporting Pynecone!🎊 Thank you for supporting Pynecone!🎊

4
LICENSE
View File

@ -1,8 +1,8 @@
Apache License Apache License
Version 2.0, January 2004 Version 2.0, January 2004
http://www.apache.org/licenses/ https://www.apache.org/licenses/LICENSE-2.0
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions. 1. Definitions.

238
README.md
View File

@ -1,25 +1,23 @@
<div align="center"> <div align="center">
<img src="docs/images/logo.png" alt="drawing" width = 450/> <img src="docs/images/logo.svg" alt="drawing" width = 450/>
**The easiest way to build and deploy web apps.** **Build performant, customizable web apps in minutes just using Python.**
[![PyPI version](https://badge.fury.io/py/pynecone-io.svg)](https://badge.fury.io/py/pynecone-io) [![PyPI version](https://badge.fury.io/py/pynecone-io.svg)](https://badge.fury.io/py/pynecone-io)
![tests](https://github.com/pynecone-io/pynecone/actions/workflows/python-checks.yml/badge.svg)
![versions](https://img.shields.io/pypi/pyversions/pynecone-io.svg) ![versions](https://img.shields.io/pypi/pyversions/pynecone-io.svg)
[![License](https://img.shields.io/badge/License-Apache_2.0-yellowgreen.svg)](https://opensource.org/licenses/Apache-2.0) [![License](https://img.shields.io/badge/License-Apache_2.0-yellowgreen.svg)](https://opensource.org/licenses/Apache-2.0)
<div align="left"> <div align="left">
## Getting Started ## Getting Started
Pynecone is a full-stack python framework that makes it easy to build and deploy web apps in minutes. Pynecone is a full-stack Python framework that makes it easy to build and deploy web apps in minutes. All the information for getting started can be found in this README. However, a more detailed explanation of the following topics can be found on our website:
All the information for getting started can be found in this README, however, a more detailed explanation of the following topics can be found on our website:
<div align="center"> <div align="center">
### [Introduction](https://pynecone.io/docs/getting-started/introduction) | [Component Library](https://pynecone.io/docs/library) | [Examples](https://pynecone.io) | [Deployment](https://pynecone.io/docs/hosting/deploy) ### [Docs](https://pynecone.io/docs/getting-started/introduction) | [Component Library](https://pynecone.io/docs/library) | [Gallery](https://pynecone.io) | [Deployment](https://pynecone.io/docs/hosting/deploy)
<div align="left"> <div align="left">
@ -50,160 +48,176 @@ You can run this app in development mode:
$ pc run $ pc run
``` ```
You should see your app running at http://localhost:3000. (Note that the port may be different if you have another app running on port 3000)
You should see your app running at http://localhost:3000.
Note that the port may be different if you have another app running on port 3000. Now you can modify the source code in `my_app_name/my_app_name.py`. Pynecone has fast refreshes so you can see your changes instantly when you save your code.
Now you can modify the source code in my_app_name/my_app_name.py. Pynecone has fast refreshes so you can see your changes instantly when you save your code. ## Example Pynecone App
## Example App Let's go over an example of creating a UI around Dalle. For simplicity of the example below, we call the OpenAI Dalle API, but you could replace this with any ML model locally.
Let's go over a simple counter app to explore the basics of Pynecone.
<div align="center"> <div align="center">
<img src="docs/images/counter.gif" alt="drawing" width="550"/> <img src="docs/images/dalle.gif" alt="drawing" width="550" style="border-radius:2%"/>
<div align="left"> <div align="left">
Here is the complete code to create this. Here is the complete code to create this. This is all done in one Python file!
- Live App: https://dalle.pynecone.app
```python ```python
import pynecone as pc import pynecone as pc
import random import openai
openai.api_key = "YOUR_API_KEY"
class State(pc.State): class State(pc.State):
count = 0 """The app state."""
prompt = ""
image_url = ""
image_processing = False
image_made = False
def increment(self): def process_image(self):
"""Increment the count.""" """Set the image processing flag to true and indicate image is not made yet."""
self.count += 1 self.image_processing = True
self.image_made = False
def decrement(self):
"""Decrement the count."""
self.count -= 1
def random(self):
"""Randomize the count."""
self.count = random.randint(0, 100)
def get_image(self):
"""Get the image from the prompt."""
response = openai.Image.create(prompt=self.prompt, n=1, size="1024x1024")
self.image_url = response["data"][0]["url"]
self.image_processing = False
self.image_made = True
def index(): def index():
"""The main view."""
return pc.center( return pc.center(
pc.vstack( pc.vstack(
pc.heading(State.count), pc.heading("DALL-E", font_size="1.5em"),
pc.hstack( pc.input(placeholder="Enter a prompt..", on_blur=State.set_prompt),
pc.button("Decrement", on_click=State.decrement, color_scheme="red"), pc.button(
pc.button( "Generate Image",
"Randomize", on_click=[State.process_image, State.get_image],
on_click=State.random, width="100%",
background_image="linear-gradient(90deg, rgba(255,0,0,1) 0%, rgba(0,176,34,1) 100%)",
color="white",
),
pc.button("Increment", on_click=State.increment, color_scheme="green"),
), ),
padding="1em", pc.divider(),
bg="#ededed", pc.cond(
border_radius="1em", State.image_processing,
box_shadow="lg", pc.circular_progress(is_indeterminate=True),
pc.cond(
State.image_made,
pc.image(
src=State.image_url,
height="25em",
width="25em",
)
)
),
bg="white",
padding="2em",
shadow="lg",
border_radius="lg",
), ),
padding_y="5em", width="100%",
font_size="2em", height="100vh",
text_align="center", bg="radial-gradient(circle at 22% 11%,rgba(62, 180, 137,.20),hsla(0,0%,100%,0) 19%)",
) )
# Add state and page to the app. # Add state and page to the app.
app = pc.App(state=State) app = pc.App(state=State)
app.add_page(index, title="Counter") app.add_page(index, title="Pynecone:DALL-E")
app.compile() app.compile()
``` ```
Let's break this down. Let's break this down.
* ### State ### **UI In Pynecone**
Lets start by talking about the UI this Pynecone App.
``` python
class State(pc.State):
count = 0
```
The state defines all the variables (called vars) in an app that can change, as well as the functions that change them.
Here our state has by a single var, count, which holds the current value of the counter.
The frontend of the app is a reflection of the current state.
* ### Event Handlers
```python
def increment(self):
"""Increment the count."""
self.count += 1
def decrement(self):
"""Decrement the count."""
self.count -= 1
def random(self):
"""Randomize the count."""
self.count = random.randint(0, 100)
```
Within the state, we define functions, called event handlers, that change the state vars.
Event handlers are the only way that we can modify the state in Pynecone. They can be called in response to user actions, such as clicking a button or typing in a text box. These actions are called events.
Our counter app has two event handlers, increment and decrement.
* ### Frontend
```python ```python
def index(): def index():
return pc.center( return pc.center(
pc.vstack( ...
pc.heading(State.count),
pc.hstack(
pc.button("Decrement", on_click=State.decrement, color_scheme="red"),
pc.button(
"Randomize",
on_click=State.random,
background_image="linear-gradient(90deg, rgba(255,0,0,1) 0%, rgba(0,176,34,1) 100%)",
color="white",
),
pc.button("Increment", on_click=State.increment, color_scheme="green"),
),
padding="1em",
bg="#ededed",
border_radius="1em",
box_shadow="lg",
),
padding_y="5em",
font_size="2em",
text_align="center",
) )
``` ```
This function defines the frontend of the app. This index function defines the frontend of the app. We use different components such as `center`, `vstack`, `input`, and `button` to build the front end. Components can be nested to create complex layouts and styled using CSS's full power. Just pass them in as keyword args.
We use different components such as pc.box, pc.button, and pc.heading to build the frontend. Components can be nested to create complex layouts, and can be styled using the full power of CSS.
Pynecone comes with [50+ built-in components](https://pynecone.io/docs/library) to help you get started. Pynecone comes with [50+ built-in components](https://pynecone.io/docs/library) to help you get started. We are actively adding more components, plus it's easy to create your own components.
We are actively adding more components, plus it's easy to create your own components.
* ### Routing ### **State**
Next we define our app and tell it what state to use. ``` python
class State(pc.State):
"""The app state."""
prompt = ""
image_url = ""
image_processing = False
image_made = False
```
The state defines all the variables (called vars) in an app that can change and the functions that change them.
Here the state is comprised of a `prompt` and `image_url`. There are also the booleans `image_processing` and `image_made` to indicate when to show the circular progress and image.
### **Event Handlers**
```python
def process_image(self):
"""Set the image processing flag to true and indicate image is not made yet."""
self.image_processing = True
self.image_made = False
def get_image(self):
"""Get the image from the prompt."""
response = openai.Image.create(prompt=self.prompt, n=1, size="1024x1024")
self.image_url = response["data"][0]["url"]
self.image_processing = False
self.image_made = True
```
Within the state, we define functions called event handlers that change the state vars. Event handlers are the way that we can modify the state in Pynecone. They can be called in response to user actions, such as clicking a button or typing in a text box. These actions are called events.
Our dalle app has two event handlers, `process_image` to indicate that the image is being generated and `get_image`, which calls the OpenAI API.
### **Routing**
Finally we define our app and tell it what state to use.
```python ```python
app = pc.App(state=State) app = pc.App(state=State)
``` ```
We add a route from the root of the app to the counter component. By default the route We add a route from the root of the app to the index component. We also add a title that will show up in the page preview/ browser tab.
```python ```python
app.add_page(index) app.add_page(index, title="Pynecone:DALL-E")
app.compile()
``` ```
You can create a multi-page app by adding more routes. You can create a multi-page app by adding more routes.
## Status
As of December 2022, Pynecone has just been released publicly and is in the **Alpha Stage**.
- :large_orange_diamond: **Public Alpha**: Anyone can install and use Pynecone. There may be issues, but we are working to resolve them activly.
- **Public Beta**: Stable enough for non-enterprise use-cases.
- **Public Hosting Beta**: **Optionally** Deploy and Host your own apps on Pynecone!
- **Public**: Pynecone is production ready.
Pynecone has new releases and features coming every week! Make sure to: :star: star and :eyes: watch this repository to stay up to date.
## Contributing ## Contributing
Pull requests are encouraged and always welcome. Pick an issue and help us out, or submit an issue id something is not working or confusing! We welcome contributions of any size! Below are some good ways to get started in the Pynecone community.
- **GitHub Discussions**: A great way to talk about features you want added or things that are confusing/need clarification.
- **GitHub Issues**: These are an excellent way to report bugs. Additionally, you can try and solve an existing issue and submit a PR.
Want to our Pynecone team or learn more about our framework? Send us an email [here](mailto:founders@pynecone.io), and we can schedule a call to discuss Pynecone and how you can start contributing.
We are actively looking for contributors, no matter your skill level or experience.
## More Information ## More Information
More information about Pynecone can be found on our website:
More information about Pynecone can be found on our website, https://pynecone.io - [Pynecone.io](https://pynecone.io)
## License ## License
Pynecone is open-source and licensed under the [Apache License 2.0](LICENSE).
Pynecone is open-source and licensed under the [Apache License 2.0](LICENSE) ## Contributors
<a href="https://github.com/picklelo"><img src="https://avatars.githubusercontent.com/u/6270214?v=4" width="50" height="50" alt=""/></a>
<a href="https://github.com/Alek99"><img src="https://avatars.githubusercontent.com/u/38776361?s=400&u=bd6c163fe787c2de1a26c881598e54b67e2482dd&v=4" width="50" height="50" alt=""/></a>
<a href="https://github.com/kbrgl"><img src="https://avatars.githubusercontent.com/u/13417496?v=4" width="50" height="50" alt=""/></a>

BIN
docs/images/dalle.gif Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 3.3 MiB

BIN
docs/images/logo.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 98 KiB

1
docs/images/logo.svg Normal file
View File

File diff suppressed because one or more lines are too long
Side by Side

After

Width:  |  Height:  |  Size: 12 KiB