diff --git a/README.md b/README.md index 22faa46cf..cedd5b147 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,33 @@
-

- Pynecone Logo - Pynecone Logo -

+ +
-**Build performant, customizable web apps in pure Python.** +**✨ Performant, customizable web apps in pure Python. Deploy in seconds.** + +📑 [Docs](https://pynecone.io/docs/getting-started/introduction)   📱 [Component Library](https://pynecone.io/docs/library)   🖼️ [Gallery](https://pynecone.io/docs/gallery)   🛸 [Deployment](https://pynecone.io/docs/hosting/deploy) [![PyPI version](https://badge.fury.io/py/pynecone.svg)](https://badge.fury.io/py/pynecone) ![tests](https://github.com/pynecone-io/pynecone/actions/workflows/build.yml/badge.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) [![Discord](https://img.shields.io/discord/1029853095527727165?color=%237289da&label=Discord)](https://discord.gg/T5WSbC2YtQ) -
+
-## Getting Started +## 📦 1. Install -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: - -
- -### [Docs](https://pynecone.io/docs/getting-started/introduction) | [Component Library](https://pynecone.io/docs/library) | [Gallery](https://pynecone.io/docs/gallery) | [Deployment](https://pynecone.io/docs/hosting/deploy) - -
- -## Installation - Pynecone requires the following to get started: -* Python 3.7+ -* [Node.js 12.22.0+](https://nodejs.org/en/) (Don't worry, you'll never have to write any Javascript) +- Python 3.7+ +- [Node.js 12.22.0+](https://nodejs.org/en/) (Don't worry, you won’t have to write any JavaScript!) ``` $ pip install pynecone ``` -## Create your first Pynecone App +## 🥳 2. Create your first app -Installing Pynecone also installs the `pc` command line tool. Test that the install was successful by creating a new project. +Installing Pynecone also installs the `pc` command line tool. Test that the install was successful by creating a new project. Replace my_app_name with your project name: @@ -51,24 +40,30 @@ $ pc init When you run this command for the first time, we will download and install [bun](https://bun.sh/) automatically. This command initializes a template app in your new directory. + +## 🏃 3. Run + You can run this app in development mode: + ``` $ pc run ``` You should see your app running at http://localhost: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. +## 🫧 Example -## Example Pynecone App +Let's go over an example: creating an image generation UI around DALL·E. For simplicity, we just call the OpenAI API, but you could replace this with an ML model run locally. -Let's go over an example of creating a UI around DALL·E. For simplicity of the example below, we call the OpenAI DALL·E API, but you could replace this with any ML model locally. + 
-drawing -
+A frontend wrapper for DALL·E, shown in the process of generating an image. +
+ +  Here is the complete code to create this. This is all done in one Python file! @@ -88,7 +83,7 @@ class State(pc.State): 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 + self.image_made = False def get_image(self): """Get the image from the prompt.""" @@ -135,28 +130,32 @@ app = pc.App(state=State) app.add_page(index, title="Pynecone:DALL·E") app.compile() ``` + Let's break this down. ### **UI In Pynecone** Let's start with the UI. -```python +```python def index(): return pc.center( ... ) ``` + This `index` function defines the frontend of the app. We use different components such as `center`, `vstack`, `input`, and `button` to build the frontend. Components can be nested within each other - to create complex layouts. And you can use keyword args to style them with the full power of CSS. +to create complex layouts. And you can use keyword args to style them with the full power of CSS. -Pynecone comes with [60+ 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](https://pynecone.io/docs/advanced-guide/wrapping-react). +Pynecone comes with [60+ built-in components](https://pynecone.io/docs/library) to help you get started. We are actively adding more components, and it's easy to [create your own components](https://pynecone.io/docs/advanced-guide/wrapping-react). ### **State** -``` python +Pynecone represents your UI as a function of your state. + +```python class State(pc.State): """The app state.""" prompt = "" @@ -164,7 +163,9 @@ class State(pc.State): 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** @@ -173,7 +174,7 @@ Here the state is comprised of a `prompt` and `image_url`. There are also the bo 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 + self.image_made = False def get_image(self): """Get the image from the prompt.""" @@ -182,21 +183,26 @@ Here the state is comprised of a `prompt` and `image_url`. There are also the bo 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 DALL·E. app has two event handlers, `process_image` to indicate that the image is being generated and `get_image`, which calls the OpenAI API. +Our DALL·E. app has two event handlers, `process_image` to indicate that the image is being generated, and `get_image`, which calls the OpenAI API. -### **Routing** +### **Routing** + +Finally, we define our app and pass it our state. -Finally we define our app and tell it what state to use. ```python app = pc.App(state=State) ``` -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. + +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 app.add_page(index, title="Pynecone:DALL-E") app.compile() ``` + You can create a multi-page app by adding more routes. ## Status @@ -205,20 +211,20 @@ Pynecone launched in December 2022. As of March 2023, we are in the **Public Beta** stage. - - :white_check_mark: **Public Alpha**: Anyone can install and use Pynecone. There may be issues, but we are working to resolve them actively. - - :large_orange_diamond: **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. +- :white_check_mark: **Public Alpha**: Anyone can install and use Pynecone. There may be issues, but we are working to resolve them actively. +- :large_orange_diamond: **Public Beta**: Stable enough for non-enterprise use-cases. +- **Public Hosting Beta**: _Optionally_, deploy and host your 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. -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 We welcome contributions of any size! Below are some good ways to get started in the Pynecone community. -- **Join Our Discord**: Our [Discord](https://discord.gg/T5WSbC2YtQ) is the best place to get help on your Pynecone project and to discuss how you can contribute. -- **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. +- **Join Our Discord**: Our [Discord](https://discord.gg/T5WSbC2YtQ) is the best place to get help on your Pynecone project and to discuss how you can contribute. +- **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. We are actively looking for contributors, no matter your skill level or experience. diff --git a/docs/images/cones.png b/docs/images/cones.png new file mode 100644 index 000000000..f3ed674c4 Binary files /dev/null and b/docs/images/cones.png differ diff --git a/docs/images/logo.png b/docs/images/logo.png new file mode 100644 index 000000000..03165a4bb Binary files /dev/null and b/docs/images/logo.png differ diff --git a/docs/images/logo_white.png b/docs/images/logo_white.png new file mode 100644 index 000000000..6d57dea24 Binary files /dev/null and b/docs/images/logo_white.png differ