Package: reflex
+ Searching for Pynecone? You are in the right repo. Pynecone has been renamed to Reflex. +✨ Performant, customizable web apps in pure Python. Deploy in seconds. ✨English|简体中文|繁體中文|Türkçe|हिंदी|Português (Brasil)|Italiano|Español|한국어⚙️ InstallationOpen a terminal and run (Requires Python 3.8+):pipinstallreflex🥳 Create your first appInstallingreflexalso installs thereflexcommand line tool.Test that the install was successful by creating a new project. (Replacemy_app_namewith your project name):mkdirmy_app_namecdmy_app_name
reflexinitThis command initializes a template app in your new directory.You can run this app in development mode:reflexrunYou should see your app running athttp://localhost:3000.Now you can modify the source code inmy_app_name/my_app_name.py. Reflex has fast refreshes so you can see your changes instantly when you save your code.🫧 Example AppLet's go over an example: creating an image generation UI aroundDALL·E. For simplicity, we just call theOpenAI API, but you could replace this with an ML model run locally.Here is the complete code to create this. This is all done in one Python file!importreflexasrximportopenaiopenai_client=openai.OpenAI()classState(rx.State):"""The app state."""prompt=""image_url=""processing=Falsecomplete=Falsedefget_image(self):"""Get the image from the prompt."""ifself.prompt=="":returnrx.window_alert("Prompt Empty")self.processing,self.complete=True,Falseyieldresponse=openai_client.images.generate(prompt=self.prompt,n=1,size="1024x1024")self.image_url=response.data[0].urlself.processing,self.complete=False,Truedefindex():returnrx.center(rx.vstack(rx.heading("DALL-E",font_size="1.5em"),rx.input(placeholder="Enter a prompt..",on_blur=State.set_prompt,width="25em",),rx.button("Generate Image",on_click=State.get_image,width="25em"),rx.cond(State.processing,rx.chakra.circular_progress(is_indeterminate=True),rx.cond(State.complete,rx.image(src=State.image_url,width="20em"),),),align="center",),width="100%",height="100vh",)# Add state and page to the app.app=rx.App()app.add_page(index,title="Reflex:DALL-E")Let's break this down.Reflex UILet's start with the UI.defindex():returnrx.center(...)Thisindexfunction defines the frontend of the app.We use different components such ascenter,vstack,input, andbuttonto 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.Reflex comes with60+ built-in componentsto help you get started. We are actively adding more components, and it's easy tocreate your own components.StateReflex represents your UI as a function of your state.classState(rx.State):"""The app state."""prompt=""image_url=""processing=Falsecomplete=FalseThe 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 apromptandimage_url. There are also the booleansprocessingandcompleteto indicate when to show the circular progress and image.Event Handlersdefget_image(self):"""Get the image from the prompt."""ifself.prompt=="":returnrx.window_alert("Prompt Empty")self.processing,self.complete=True,Falseyieldresponse=openai_client.images.generate(prompt=self.prompt,n=1,size="1024x1024")self.image_url=response.data[0].urlself.processing,self.complete=False,TrueWithin 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 Reflex. 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 an event handler,get_imageto which get this image from the OpenAI API. Usingyieldin the middle of an event handler will cause the UI to update. Otherwise the UI will update at the end of the event handler.RoutingFinally, we define our app.app=rx.App()We add a page 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.app.add_page(index,title="DALL-E")You can create a multi-page app by adding more pages.📑 Resources📑Docs|    🗞️Blog|    📱Component Library|    🖼️Gallery|    🛸Deployment✅ StatusReflex launched in December 2022 with the name Pynecone.As of July 2023, we are in thePublic Betastage.:white_check_mark:Public Alpha: Anyone can install and use Reflex. 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 Reflex!Public: Reflex is production ready.Reflex has new releases and features coming every week! Make sure to :star: star and :eyes: watch this repository to stay up to date.ContributingWe welcome contributions of any size! Below are some good ways to get started in the Reflex community.Join Our Discord: OurDiscordis the best place to get help on your Reflex 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:Issuesare 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. To contribute check outCONTIBUTING.mdAll Thanks To Our Contributors:LicenseReflex is open-source and licensed under theApache License 2.0.