https://github.com/reflex-dev/reflex Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code Explore + All features + Documentation + GitHub Skills + Blog * Solutions For + Enterprise + Teams + Startups + Education By Solution + CI/CD & Automation + DevOps + DevSecOps Resources + Customer Stories + White papers, Ebooks, Webinars + Partners * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. {{ message }} reflex-dev / reflex Public * Notifications * Fork 627 * Star 10.3k Web apps in pure Python reflex.dev License Apache-2.0 license 10.3k stars 627 forks Activity Star Notifications * Code * Issues 254 * Pull requests 21 * Discussions * Actions * Projects 1 * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights reflex-dev/reflex This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 26 branches 31 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/r] Use Git or checkout with SVN using the web URL. [gh repo clone reflex] Work fast with our official CLI. Learn more about the CLI. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @Lendemor Lendemor fix state reset() (#1501) ... 9222bbb Aug 2, 2023 fix state reset() (#1501) 9222bbb Git stats * 549 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github check_initialized: skip REFLEX_DIR check for backend only (#1478) August 2, 2023 06:33 docker-example docker-example: update executable and README (#1499) August 2, 2023 11:01 docs Update Readme (#1463) July 30, 2023 20:56 integration check_initialized: skip REFLEX_DIR check for backend only (#1478) August 2, 2023 06:33 reflex fix state reset() (#1501) August 2, 2023 11:02 scripts scripts/integration: fix mismerge -- wait for $check_ports (#1504) August 2, 2023 10:42 tests fix state reset() (#1501) August 2, 2023 11:02 .coveragerc Full OS matrix builds for unit and integration tests (Linux, Mac, Win... August 1, 2023 11:34 .gitignore dev-mode compile: purge .web dir at last min to reduce downtime window ( July 26, 2023 16:04 .pre-commit-config.yaml dev-mode compile: purge .web dir at last min to reduce downtime window ( July 26, 2023 16:04 CODE_OF_CONDUCT.md Updated README and Contributing (#25) December 4, 2022 19:51 CONTRIBUTING.md Guide to clone the correct repo in CONTRIBUTING.md (#1471) July 31, 2023 08:57 LICENSE Rename pynecone to reflex (#1236) June 25, 2023 16:56 README.md Update badge on README (#1498) August 1, 2023 16:19 SECURITY.md Update to v0.1.21 (#762) April 2, 2023 17:00 poetry.lock Full OS matrix builds for unit and integration tests (Linux, Mac, Win... August 1, 2023 11:34 pyproject.toml Bump version to 0.2.3 (#1481) August 1, 2023 09:40 View code [ ] Performant, customizable web apps in pure Python. Deploy in seconds. English | Jian Ti Zhong Wen | Fan Ti Zhong Wen [?][?] Installation Create your first app Example App Let's break this down. Reflex UI State Event Handlers Routing Resources Status Contributing License README.md + Searching for Pynecone? You are in the right repo. Pynecone has been renamed to Reflex. + Reflex Logo Reflex Logo --------------------------------------------------------------------- Performant, customizable web apps in pure Python. Deploy in seconds. PyPI version tests versions Documentaiton Discord --------------------------------------------------------------------- English | Jian Ti Zhong Wen | Fan Ti Zhong Wen [?][?] Installation Open a terminal and run (Requires Python 3.7+): pip install reflex Create your first app Installing reflex also installs the reflex command line tool. Test that the install was successful by creating a new project. (Replace my_app_name with your project name): mkdir my_app_name cd my_app_name reflex init This command initializes a template app in your new directory. You can run this app in development mode: reflex 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. Reflex has fast refreshes so you can see your changes instantly when you save your code. Example 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. 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! import reflex as rx import openai openai.api_key = "YOUR_API_KEY" class State(rx.State): """The app state.""" prompt = "" image_url = "" processing = False complete = False def get_image(self): """Get the image from the prompt.""" if self.prompt == "": return rx.window_alert("Prompt Empty") self.processing, self.complete = True, False yield response = openai.Image.create(prompt=self.prompt, n=1, size="1024x1024") self.image_url = response["data"][0]["url"] self.processing, self.complete = False, True def index(): return rx.center( rx.vstack( rx.heading("DALL*E"), rx.input(placeholder="Enter a prompt", on_blur=State.set_prompt), rx.button( "Generate Image", on_click=State.get_image, is_loading=State.processing, width="100%", ), rx.cond( State.complete, rx.image( src=State.image_url, height="25em", width="25em", ) ), padding="2em", shadow="lg", border_radius="lg", ), width="100%", height="100vh", ) # Add state and page to the app. app = rx.App() app.add_page(index, title="reflex:DALL*E") app.compile() Let's break this down. Reflex UI Let's start with the UI. def index(): return rx.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. Reflex comes with 60+ built-in components to help you get started. We are actively adding more components, and it's easy to create your own components. State Reflex represents your UI as a function of your state. class State(rx.State): """The app state.""" prompt = "" image_url = "" processing = False complete = 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 processing and complete to indicate when to show the circular progress and image. Event Handlers def get_image(self): """Get the image from the prompt.""" if self.prompt == "": return rx.window_alert("Prompt Empty") self.processing, self.complete = True, False yield response = openai.Image.create(prompt=self.prompt, n=1, size="1024x1024") self.image_url = response["data"][0]["url"] self.processing, self.complete = False, 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 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_image to which get this image from the OpenAI API. Using yield in the middle of an event handler will cause the UI to update. Otherwise the UI will update at the end of the event handler. Routing Finally, 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") app.compile() You can create a multi-page app by adding more pages. Resources Docs | [?] Blog | Component Library | [?] Gallery | Deployment Status Reflex launched in December 2022 with the name Pynecone. As of July 2023, we are in the Public Beta stage. * Public Alpha: Anyone can install and use Reflex. There may be issues, but we are working to resolve them actively. * 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 and 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 Reflex community. * Join Our Discord: Our Discord is 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: 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. License Reflex is open-source and licensed under the Apache License 2.0. About Web apps in pure Python reflex.dev Topics python open-source framework python-library webdev webdevelopment Resources Readme License Apache-2.0 license Code of conduct Code of conduct Security policy Security policy Activity Stars 10.3k stars Watchers 86 watching Forks 627 forks Report repository Releases 29 v0.2.3 Latest Jul 31, 2023 + 28 releases Packages 0 No packages published Used by 60 * @ademolab91 * @reflex-playground * @scraptured * @e-normous * @reflex-dev * @samcloudcode * @MajorMistake * @reflex-playground + 52 Contributors 62 * @picklelo * @Alek99 * @ElijahAhianyo * @Lendemor * @masenf * @milochen0418 * @PeterYusuke * @sheldonchiu * @TaiJuWu * @d29107d * @r0b2g1t + 51 contributors Languages * Python 94.1% * JavaScript 4.6% * Jinja 0.9% * Dockerfile 0.2% * Shell 0.2% * Batchfile 0.0% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time.