Skip to main content

A Gemini Application Framework

Project description

Xitzin

Application Framework for the Geminispace

Xitzin brings a modern Python developer experience to the Gemini protocol. Build Gemini capsules with familiar patterns: decorators for routing and type-annotated path parameters.

from xitzin import Xitzin, Request

app = Xitzin()

@app.gemini("/")
def home(request: Request):
    return "# Welcome to my capsule!"

@app.gemini("/user/{username}")
def profile(request: Request, username: str):
    return f"# {username}'s Profile"

@app.input("/search", prompt="Enter query:")
def search(request: Request, query: str):
    return f"# Results for: {query}"

if __name__ == "__main__":
    app.run()

Features

  • Decorator-based routing with @app.gemini() and automatic path parameter extraction
  • User input handling via @app.input() for Gemini's status 10/11 prompts
  • Certificate authentication with @require_certificate and fingerprint whitelisting
  • Jinja2 templates with Gemtext-aware filters (links, headings, lists)
  • Middleware support for logging, rate limiting, and custom processing
  • Testing utilities with in-memory TestClient
  • Async support for both sync and async handlers

Installation

pip install xitzin

Or with uv:

uv add xitzin

Quick Start

  1. Create app.py:
from xitzin import Xitzin, Request

app = Xitzin()

@app.gemini("/")
def home(request: Request):
    return "# Hello, Geminispace!"

if __name__ == "__main__":
    app.run()
  1. Generate TLS certificates:
openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes -subj "/CN=localhost"
  1. Run your capsule:
python app.py
  1. Visit gemini://localhost/ with a Gemini client like Astronomo.

Documentation

Full documentation is available at xitzin.readthedocs.io.

License

MIT

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

xitzin-0.7.0.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

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

xitzin-0.7.0-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

Details for the file xitzin-0.7.0.tar.gz.

File metadata

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

File hashes

Hashes for xitzin-0.7.0.tar.gz
Algorithm Hash digest
SHA256 bf85d1148a107b1e2bbe039fb329c563273f597918b7e6cb7c794e982755a51b
MD5 52f479382b7deb150e063bb0a8b11621
BLAKE2b-256 b3dc235152a7c068756c1a0ffa5fe5a34a0389bb0bdc02a3caee08bcd3a691e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for xitzin-0.7.0.tar.gz:

Publisher: release-pypi.yml on alanbato/xitzin

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

File details

Details for the file xitzin-0.7.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for xitzin-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8bcdba332f13b740fc5986c5701b50cf9bd75cb435c8929959f7b1a15be71cd1
MD5 d32aa44847ce00b62c8cc3bbd23d95da
BLAKE2b-256 521ce193c412039a0377e6a120bbf184f291fbdae8879c179d7ee8525ab0bd4d

See more details on using hashes here.

Provenance

The following attestation bundles were made for xitzin-0.7.0-py3-none-any.whl:

Publisher: release-pypi.yml on alanbato/xitzin

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