A Python Framework for writing Reactive web Front-Ends
Project description
Starfyre ⭐🔥
Introduction:
Starfyre is a library that allows you to build reactive frontends using only Python. With Starfyre, you can create interactive, real-time applications with minimal effort. Simply define your frontend as a collection of observables and reactive functions, and let Starfyre handle the rest.
📦 Installation:
pip install starfyre
A sample project is hosted on GitHub.
🚀 Sample App
To create an application
python3 -m starfyre --create="my-app"
my-app/src/__init__.fyre
from .parent import parent
from .store import store
def mocked_request():
return "fetched on the server"
async def handle_on_click(e):
alert("click rendered on client")
if 1==1:
print("Hello world")
current_value = get_parent_signal()
set_parent_signal(current_value + 1)
a = await fetch('https://jsonplaceholder.typicode.com/todos/1')
print(await a.text())
print("handles on click")
<style>
body {
background-color: red;
}
</style>
<pyxide>
<store>
<parent hello='world'>
<span onclick={handle_on_click}>
{[ mocked_request() for i in range(4)]}
</span>
</parent>
</store>
</pyxide>
<script>
// this is the optional section
// for third party scripts and custom js
</script>
🚀 Sample CLI usage
Usage: python -m starfyre [OPTIONS]
Command-line interface to compile and build a Starfyre project.
Args:
path (str): Path to the project directory.
build (bool): Whether to start the build package.
create (str): Name of the project to create.
serve (bool): Whether to serve the project.
Options:
--path TEXT Path to the project. Requires --build.
--build Compile and build package. Requires --path.
--create TEXT Create a new project. Requires a project name.
--serve Serve the project. Requires --path.
--help Show this message and exit.
🗒️ How to contribute
🏁 Get started
Please read the code of conduct and go through CONTRIBUTING.md before contributing to Starfyre. Feel free to open an issue for any clarifications or suggestions.
If you're feeling curious. You can take a look at a more detailed architecture here.
If you still need help to get started, feel free to reach out on our community discord.
⚙️ Developing Locally
Python version 3.10
- Fork this repo
- Clone this repo -
git clone https://github.com/sparckles/starfyre - Go in to the starfyre directory -
cd starfyre - Download poetry
curl -sSL https://install.python-poetry.org/ | python3 - - Install the dependencies
poetry install - Activate poetry virtual environment
poetry shell - Run the script
./build.sh. This command will run the build process in starfyre against the test application intest-applicationdirectory.
- The
build.shfile is a simple script that runs two commands sequentially.python -m starfyre --build=True --path="test_application/"- The
pathvariable here is the path to our application. - The
builddirectory is basically a python package that contains all the compiled files. We use the--buildflag to run that package.
- The
- You can find a small test application in the
test_applicationdirectory. - Navigate to
cd test_application/dist. - Open
index.htmlin your browser to see the output.
Feedback
Feel free to open an issue and let me know what you think of it.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for starfyre-0.18.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 83ebc38760254b9fc3f0591238cf2f53c8c45edf4dd9ea0042d13ba14f973993 |
|
| MD5 | 86ae5b1f72e621eade032ac7083cb309 |
|
| BLAKE2b-256 | 85161bdb5e06003beb8fd1fbf3a1aaba09c566303519a0b5b1430588699ccd85 |
