Skip to main content

Framework for easy small local web apps or programs

Project description

Starbear

Documentation

Tutorial

Starbear allow creating interactive local web applications in Python very easily.

  • The entire app is a single async function.
  • Call Python functions from JS, call JS functions from Python.
  • No subroutes: starbear automatically creates the endpoints you need.

Be careful about using this in production: Starbear is a beta, experimental framework. It is not highly efficient and may not scale very well, therefore you should use this for small apps that you want to run locally or that don't need high uptime and reliability.

Install

pip install starbear

Example

from hrepr import H
from pathlib import Path
from starbear import bear, Queue

@bear
async def app(page):
    # Events coming from the webpage will be added to this Queue
    q = Queue()

    # You can print to any part of the page using a CSS selector, for
    # example we can add stuff to the <head> element:
    page["head"].print(
        # Use H.xyz to create a <xyz> node
        H.title("Clicking game!"),
        # If you give a Path object, Starbear will serve the corresponding
        # file for you.
        H.link(rel="stylesheet", href=Path("path/to/style.css"))
    )

    # page.print prints to <body> by default
    page.print(
        # If you give a Queue as an onclick handler, the events will be
        # accumulated in that queue. You can also give a Python function
        # as a handler.
        H.button("Click me!", onclick=q),
        H.div(
            # This is the span we want to update, so we put it in a variable
            target := H.span("0", id=True),
            " clicks"
        )
    )

    i = 0
    # And now we can simply loop over the event queue. Be careful to use *async* for,
    # which will yield to the event loop between each iteration.
    async for event in q:
        i += 1
        # We can index the page using any node we created and set its contents
        # to whatever we desire.
        page[target].set(str(i))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

starbear-0.2.5.tar.gz (10.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

starbear-0.2.5-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

Details for the file starbear-0.2.5.tar.gz.

File metadata

  • Download URL: starbear-0.2.5.tar.gz
  • Upload date:
  • Size: 10.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for starbear-0.2.5.tar.gz
Algorithm Hash digest
SHA256 67e63b1e1c8c1283c5720b949a62e9ea698f17e588de7c8274f632aed8d73c8c
MD5 99e768e138fe6f9b8d2b96ec29197c6d
BLAKE2b-256 6d6617d06279b24a30a8915130c92865752e05b011c89ab2baef191c52a56e41

See more details on using hashes here.

File details

Details for the file starbear-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: starbear-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 48.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for starbear-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1967f4ee980d83f0ebc7b31c97d7ebebb695652de5913b736b3357250a9de8d8
MD5 691d49a3fa9bc619dbb0ed80259e51d4
BLAKE2b-256 07ea6e61febb5994ff9eb2e1b44a6e39c67ae7feabac2667932b8559528894f1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page