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.6.tar.gz (111.7 kB 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.6-py3-none-any.whl (48.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: starbear-0.2.6.tar.gz
  • Upload date:
  • Size: 111.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for starbear-0.2.6.tar.gz
Algorithm Hash digest
SHA256 a9a0784a4bd7556f9f9604a51ba69d6eb523a94b747e351341d2e809da4ad183
MD5 cad217e057f43dec1d61f6a1105bb98f
BLAKE2b-256 e93710ced4b0b52da505d50928c0333fa0e7f4c2fa4574aa551db6d050d8a54f

See more details on using hashes here.

Provenance

The following attestation bundles were made for starbear-0.2.6.tar.gz:

Publisher: publish.yml on breuleux/starbear

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: starbear-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 48.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for starbear-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e33eec1b7860118a6383818e47ee97f4f8dcf63f3ef03524577a632ef7ce0199
MD5 f303835fd3cc22d094d11784128593ba
BLAKE2b-256 2b91ab04098f9c91a7ab7c80b00fa91d8367c7e4a694b95f7da143da41d51fb1

See more details on using hashes here.

Provenance

The following attestation bundles were made for starbear-0.2.6-py3-none-any.whl:

Publisher: publish.yml on breuleux/starbear

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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