<p align="center">
  <img src="https://github.com/rio-labs/rio/blob/dev/rio/assets/hosted/rio-logos/logo-and-text-horizontal.png?raw=true" alt="Rio Logo" style="width: 16rem"/>
</p>

<p align="center">
  <strong>Rio</strong> is an easy to use framework for creating websites and apps and is based <strong>entirely on Python</strong>. 🐍 
  <br>
  You <strong>won't need a single line of HTML, CSS, or
  JavaScript</strong> to create beautiful, modern apps.<br><br>
  <a href="https://rio.dev/get-started">Tutorial</a> - <a href="https://rio.dev/examples">Examples</a> - <a href="https://discord.gg/7ejXaPwhyH">Discord</a> - <a href="https://rio.dev/docs">Docs</a> - <a href="https://github.com/rio-labs/rio">Source Code</a><br><br>
  Rio brings React-style components to Python. Pull from a wealth of built-in
  components and combine them to create your own custom components. Then combine
  those into entire apps. Best of all, Rio apps can run both locally on your
  machine and on the web.
</p>

<p align="center">
  <img src="https://img.shields.io/badge/Rio-outline.svg?color=%2311e8e3e&link=https%3A%2F%2Frio.dev&style=flat-square&logo=data:image/svg%2bxml;base64, " alt="Rio"/>
  <img src="https://img.shields.io/pypi/v/rio-ui?color=%2311e8e3e&style=flat-square" alt="Version"/>
  <img src="https://img.shields.io/discord/1213589765484576818?color=%2311e8e3e&label=discord&style=flat-square" alt="Discord"/>
  <img src="https://img.shields.io/pypi/pyversions/rio-ui?style=flat-square" alt="Python Version"/>
  <img src="https://img.shields.io/pypi/l/rio-ui?color=%2311e8e3e&style=flat-square" alt="License"/>
  <img src="https://img.shields.io/github/stars/rio-labs/rio?style=flat-square" alt="GitHub Stars"/>
</p>

<video src="https://github.com/rio-labs/rio/assets/41641225/0b5c87ef-7349-4317-ae16-3859f3889d18"></video>

## Features 🧩

-   Modern, **declarative UI** framework
-   **100% Python** - Zero HTML, CSS, or JavaScript required
-   Over **50 Built-in components** for common UI elements, such as `rio.Switch`, `rio.Button`, and `rio.Text`, and many more
-   Integrates with **modern Python tooling**: Thanks to being **entirely Type Safe** editors can give you instant suggestions and highlight problems right away
-   Apps can run **both locally and on the web**
-   **Open Source & Free forever**

## Example ⌨️

```python
# Define a component that counts button clicks
class ButtonClicker(rio.Component):
    # Define the attributes of the component. Changing these will
    # affect the GUI.
    clicks: int = 0

    # Define a method that increments the click count. We'll later
    # make a button that calls this method whenever it is pressed.
    def _on_press(self) -> None:
        self.clicks += 1

    # Define the `build` method. This method essentially tells rio
    # what a ButtonClicker component looks like. Whenever the state
    # of the ButtonClicker component changes, rio will call its
    # `build` method and update the GUI according to the output.
    def build(self) -> rio.Component:
        return rio.Column(
            rio.Button('Click me', on_press=self._on_press),
            rio.Text(f'You clicked the button {self.clicks} time(s)'),
        )

# Create an App and tell it to display a ButtonClicker when it starts
app = rio.App(build=ButtonClicker)
app.run_in_browser()
```

## Installation 🛠️

Rio is available on PyPI, so you can install it using pip:

```bash
pip install rio-ui
```

## Getting Started 🎓

Rio comes with a very helpful command line utility to help you out. Create a new project in one short command:

```bash
rio new
```

You can choose from a variety of built-in templates to get you started. Here's a complete example to create a project based on the tic-tac-toe template:

```bash
rio new my-project --type website --template "Tic-Tac-Toe"
cd my-project
rio run
```

You'll have your first app up and running in seconds!

## Status: In Development 🚧

Rio is still in development. We're working hard to bring you the best possible
experience. If you have any feedback, please let us know on [our Discord server](https://discord.gg/7ejXaPwhyH).

## Contributing 🤝

TODO: Write how someone can contribute to the project. :)
