Skip to main content

Python-first UI component library for Datastar/StarHTML applications

Project description

StarHTML — Python Web Framework

StarUI — Python Component Library

PyPI version Python 3.12+

Python-first UI component library for StarHTML. shadcn/ui components with zero-configuration setup.

Documentation · StarHTML · Quick Start · Issues

Quick Start

uv add starui
from starhtml import *
from starui import *

app, rt = star_app()

@rt("/")
def home():
    return Card(
        CardHeader(
            CardTitle("Welcome to StarUI")
        ),
        CardContent(
            Button("Get Started", variant="default"),
            Button("Learn More", variant="outline")
        )
    )

serve()

Available Components

Component Description Variants
Button Interactive buttons default, destructive, outline, secondary, ghost, link
Alert Important messages default, destructive
Badge Status indicators default, secondary, destructive, outline
Card Content containers Header, Content, Footer sections
Input Form inputs All HTML input types with validation
Label Form labels Accessible form labeling

CLI

star init <project-name>          # Create new project
star add <component>              # Add component to project
star list                         # List available components
star dev <app.py>                 # Dev server with hot reload
star build                        # Build production CSS

Component API

Button

Button("Click me")

Button(
    "Submit Form",
    variant="default",
    size="lg",
    disabled=False,
    type="submit",
    onclick="handleSubmit()"
)

Card

Card(
    CardHeader(
        CardTitle("Product Card")
    ),
    CardContent(
        P("This is the card content with detailed information."),
        Button("Learn More", variant="outline")
    ),
    class_name="max-w-md"
)

Configuration

StarUI works with zero configuration, but you can customize it:

# starui.config.py (optional)
from starui.config import ProjectConfig
from pathlib import Path

config = ProjectConfig(
    project_root=Path.cwd(),
    css_output=Path("static/css/starui.css"),
    component_dir=Path("components/ui")
)

Development

git clone https://github.com/banditburai/starui.git
cd starui
uv sync --all-extras
uv run ruff check && uv run pyright && uv run pytest tests/ -v

Contributions welcome — see CONTRIBUTING.md.

Acknowledgments

Built on shadcn/ui design patterns, StarHTML, and Tailwind CSS.

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

starui-0.2.0.tar.gz (58.4 kB view details)

Uploaded Source

Built Distribution

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

starui-0.2.0-py3-none-any.whl (88.6 kB view details)

Uploaded Python 3

File details

Details for the file starui-0.2.0.tar.gz.

File metadata

  • Download URL: starui-0.2.0.tar.gz
  • Upload date:
  • Size: 58.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for starui-0.2.0.tar.gz
Algorithm Hash digest
SHA256 64327f14863cdc7472a124974d2f6b78bb61ed0d8bfc1141574fdc8cc917fb38
MD5 d4861068c24fdfa512b4239eb1f8cabc
BLAKE2b-256 c2a1a8cc114e79de4f9cdad3dab1d65d327e72093e47830d78aaa4196eae8d35

See more details on using hashes here.

Provenance

The following attestation bundles were made for starui-0.2.0.tar.gz:

Publisher: release.yml on banditburai/starUI

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

File details

Details for the file starui-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: starui-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 88.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for starui-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c0d76bea9ad17e14ed7cdaf7bdedcb80d0150bc95b62d053ac2722bc4ef9d97f
MD5 b461d3451d8d1397f318be4757e84882
BLAKE2b-256 403d9891b71d5fc3f52adf03b56fe3f940c53bbc02a19e12b4fe67c7b7d852ed

See more details on using hashes here.

Provenance

The following attestation bundles were made for starui-0.2.0-py3-none-any.whl:

Publisher: release.yml on banditburai/starUI

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