Skip to main content
Citry

Citry: a fully typed frontend framework for Python

PyPI - Version PyPI - Python Version License CI Docs Discord

Citry is a fully typed frontend framework for Python with server events and Vue. One component can own its HTML, browser behavior, CSS, translations, and Python event handlers, so you can build an interactive interface without maintaining a separate frontend application. It is inspired by Vue and Livewire.

Citry works with FastAPI, Django, Flask, Starlette, ASGI, and WSGI applications.

Citry is in public beta. It supports Python 3.10 through 3.14.

Read the docs · Try the playground · Explore examples · Install the VS Code extension · Browse Citry UI

Watch the tutorial:

Watch the 50-minute Citry and Django code-along on YouTube

Start with one component

Install Citry:

python -m pip install citry

Or add it to a uv project:

uv add citry

Define a component in ordinary Python. Typed inputs catch misspellings and missing values, while template_data() chooses exactly what the template can read:

from citry import Component


class Welcome(Component):
    class Kwargs:
        name: str
        messages: list[str]

    def template_data(self, kwargs, slots):
        return {
            "name": kwargs.name,
            "messages": kwargs.messages,
        }

    def css_data(self, kwargs, slots):
        return {"accent": "tomato"}

    template = """
      <section class="welcome">
        <h1>Welcome back, {{ name }}!</h1>
        <ul>
          <li c-for="message in messages">
            {{ message }}
          </li>
          <li c-empty>Nothing new yet.</li>
        </ul>
      </section>
    """

    css = """
      .welcome {
        border-top: 3px solid var(--accent);
      }
    """


html = str(
    Welcome(
        name="Ada",
        messages=["Build finished", "Report ready"],
    )
)

Components compose through HTML-like tags. Static inputs look like ordinary HTML attributes; prefix an input with c- when its value is a Python expression:

<main>
  <c-Welcome name="Ada" c-messages="user.inbox" />
</main>

That is most of the template language:

  1. <c-Name> renders a component or a built-in control-flow tag.
  2. A c- attribute evaluates a Python expression.

Continue with the step-by-step tutorial or read the template syntax guide.

Build the whole interface in Python

Citry gives each part of an interface a clear home:

What you need What Citry provides
Reusable UI Components, typed inputs, slots, composition, and error boundaries
Browser behavior Vue expressions, component JavaScript, CSS, and managed assets
Python interactions Server events, forms, persistent State, and targeted HTML updates
Internationalization Fluent catalogs, locale-aware formatting, and server/browser translations
Production control Caching, HTML fragments, strict CSP support, CSRF hooks, and debug tooling
Editor help Highlighting, completion, navigation, diagnostics, and safe formatting

Learn these features through the component guides, Events documentation, and advanced guides.

Need ready-made application components? Install Citry UI for accessible forms, dialogs, navigation, feedback, data display, theming, and translated default labels:

python -m pip install citry-ui

Connect a web application

Mount Citry on the web framework that already serves your application. For example, with FastAPI or Starlette:

from citry import citry
from citry.contrib.fastapi import mount


mount(app, citry)
citry.initialize()

Citry includes adapters for:

Host Integration
FastAPI / Starlette citry.contrib.fastapi.mount()
Django citry.contrib.django.urlpatterns()
Flask citry.contrib.flask.mount()
Any ASGI application citry.contrib.asgi.asgi_app()
Any WSGI application citry.contrib.wsgi.wsgi_app()

The web-framework guide shows the right startup and routing setup for each host.

Want a complete project instead of an integration excerpt? Copy the FastAPI starter or choose from the standalone, Django, Flask, ASGI, and WSGI starter matrix. The collection also includes complete Project Board and HTMX integration demos. Each project has its own dependencies, lockfile, and tests. Every web starter includes a browser interaction powered by Citry Events. The HTMX demo uses HTMX for every request and page update.

Use the editor and command line

The free Citry extension for VS Code understands the HTML, Python, JavaScript, CSS, and Fluent inside a component. It provides completion, hover help, navigation, references, diagnostics, and safe formatting. The same extension is available from Open VSX.

Citry also installs a command-line checker:

citry check --static

Point it at an application for registered component contracts and template data:

citry --app myproject.app:citry_app check

See the VS Code guide and CLI reference for setup and CI usage.

Work with a coding agent

Point your agent at Citry's documentation index and your project's setup and test commands. The AI coding agents guide includes instructions for existing projects and explains the agent files included in the current starter projects. You do not need to install a Citry skill.

Performance

The benchmarks page shows how long a page with 1,400 rendered entries takes to become usable in Citry and eleven other frameworks, including Django with HTMX and Alpine, django-components, Next.js and Nuxt.

Get help and contribute

Citry continues the component work begun in django-components and django-components/djc-core.

License

MIT

Metadata

Release files for citry 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for citry 0.6.0
File Size Uploaded Provenance Actions
citry-0.6.0.tar.gz 2.1 MB With provenance Details for citry-0.6.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for citry 0.6.0
File Interpreter ABI Platform Actions
citry-0.6.0-py3-none-any.whl Python 3 none any Details for citry-0.6.0-py3-none-any.whl

Total release size: 3.3 MB

Release files / citry-0.6.0.tar.gz

Download URL citry-0.6.0.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums
93049bd77e067e5fee7eeee362e8829e55deeaf4c18dc8c66d55654f2972ff9b
BLAKE2b-256 checksum
How to use checksums
202e3b5142abfd202a4bf6669a142c32537ec1255d7d1b69785bc228f28450a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Release files / citry-0.6.0-py3-none-any.whl

Download URL citry-0.6.0-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
125a83e9882f14c27be9e5473d3242614cca5d51294447f0b60728ba51a0a923
BLAKE2b-256 checksum
How to use checksums
016d205cf20ef75e0047295b2aa46d8bcc2161dc03752acb6cc22241fd625f4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Security for citry 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for citry-0.6.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page