xitzin 0.1.2__tar.gz

xitzin-0.1.2/PKG-INFO

@@ -0,0 +1,118 @@
+Metadata-Version: 2.3
+Name: xitzin
+Version: 0.1.2
+Summary: A Gemini Application Framework
+Keywords: gemini,protocol,framework,async,geminispace
+Author: Alan Velasco
+Author-email: Alan Velasco <alanvelasco.a@gmail.com>
+License: MIT
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Typing :: Typed
+Requires-Dist: jinja2>=3.1.0
+Requires-Dist: nauyaca>=0.3.2
+Requires-Dist: rich>=14.2.0
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Python: >=3.10
+Project-URL: Changelog, https://xitzin.readthedocs.io/changelog/
+Project-URL: Documentation, https://xitzin.readthedocs.io
+Project-URL: Homepage, https://github.com/alanbato/xitzin
+Project-URL: Issues, https://github.com/alanbato/xitzin/issues
+Project-URL: Repository, https://github.com/alanbato/xitzin.git
+Description-Content-Type: text/markdown
+
+# Xitzin
+
+**Application Framework for the Geminispace**
+
+Xitzin brings a modern Python developer experience to the [Gemini protocol](https://geminiprotocol.net/). Build Gemini capsules with familiar patterns: decorators for routing and type-annotated path parameters.
+
+```python
+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
+
+```bash
+pip install xitzin
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add xitzin
+```
+
+## Quick Start
+
+1. Create `app.py`:
+
+```python
+from xitzin import Xitzin, Request
+
+app = Xitzin()
+
+@app.gemini("/")
+def home(request: Request):
+    return "# Hello, Geminispace!"
+
+if __name__ == "__main__":
+    app.run()
+```
+
+2. Generate TLS certificates:
+
+```bash
+openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes -subj "/CN=localhost"
+```
+
+3. Run your capsule:
+
+```bash
+python app.py
+```
+
+4. Visit `gemini://localhost/` with a Gemini client like [Astronomo](https://github.com/alanbato/astronomo/).
+
+## Documentation
+
+Full documentation is available at [xitzin.readthedocs.io](https://xitzin.readthedocs.io/).
+
+## License
+
+MIT

xitzin-0.1.2/README.md

@@ -0,0 +1,87 @@
+# Xitzin
+
+**Application Framework for the Geminispace**
+
+Xitzin brings a modern Python developer experience to the [Gemini protocol](https://geminiprotocol.net/). Build Gemini capsules with familiar patterns: decorators for routing and type-annotated path parameters.
+
+```python
+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
+
+```bash
+pip install xitzin
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add xitzin
+```
+
+## Quick Start
+
+1. Create `app.py`:
+
+```python
+from xitzin import Xitzin, Request
+
+app = Xitzin()
+
+@app.gemini("/")
+def home(request: Request):
+    return "# Hello, Geminispace!"
+
+if __name__ == "__main__":
+    app.run()
+```
+
+2. Generate TLS certificates:
+
+```bash
+openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -days 365 -nodes -subj "/CN=localhost"
+```
+
+3. Run your capsule:
+
+```bash
+python app.py
+```
+
+4. Visit `gemini://localhost/` with a Gemini client like [Astronomo](https://github.com/alanbato/astronomo/).
+
+## Documentation
+
+Full documentation is available at [xitzin.readthedocs.io](https://xitzin.readthedocs.io/).
+
+## License
+
+MIT

xitzin-0.1.2/pyproject.toml

@@ -0,0 +1,58 @@
+[project]
+name = "xitzin"
+version = "0.1.2"
+description = "A Gemini Application Framework"
+readme = "README.md"
+license = { text = "MIT" }
+authors = [
+    { name = "Alan Velasco", email = "alanvelasco.a@gmail.com" }
+]
+requires-python = ">=3.10"
+keywords = ["gemini", "protocol", "framework", "async", "geminispace"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Typing :: Typed",
+]
+dependencies = [
+    "jinja2>=3.1.0",
+    "nauyaca>=0.3.2",
+    "rich>=14.2.0",
+    "typing-extensions>=4.15.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/alanbato/xitzin"
+Documentation = "https://xitzin.readthedocs.io"
+Repository = "https://github.com/alanbato/xitzin.git"
+Issues = "https://github.com/alanbato/xitzin/issues"
+Changelog = "https://xitzin.readthedocs.io/changelog/"
+
+[build-system]
+requires = ["uv_build>=0.9.10,<0.10.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.5.1",
+    "pytest>=9.0.2",
+    "pytest-asyncio>=0.24.0",
+    "pytest-cov>=7.0.0",
+    "ruff>=0.14.10",
+    "ty>=0.0.8",
+]
+docs = [
+    "mkdocs>=1.6.1",
+    "mkdocs-material>=9.5.0",
+    "mkdocstrings[python]>=0.24.0",
+    "mkdocs-git-revision-date-localized-plugin>=1.2.0",
+    "pymdown-extensions>=10.20",
+]

xitzin-0.1.2/src/xitzin/__init__.py

@@ -0,0 +1,78 @@
+"""Xitzin - A Gemini Application Framework.
+
+Xitzin is a framework for building Gemini protocol applications.
+It uses Nauyaca for Gemini protocol communication.
+
+Example:
+    from xitzin import Xitzin, Request
+
+    app = Xitzin()
+
+    @app.gemini("/")
+    def home(request: Request):
+        return "# Welcome to Gemini!"
+
+    @app.gemini("/user/{username}")
+    def profile(request: Request, username: str):
+        return f"# {username}'s Profile"
+
+    if __name__ == "__main__":
+        app.run()
+"""
+
+from .application import Xitzin
+from .cgi import CGIConfig, CGIHandler, CGIScript
+from .exceptions import (
+    BadRequest,
+    CertificateNotAuthorized,
+    CertificateNotValid,
+    CertificateRequired,
+    CGIError,
+    GeminiException,
+    Gone,
+    InputRequired,
+    NotFound,
+    PermanentFailure,
+    ProxyError,
+    ProxyRequestRefused,
+    SensitiveInputRequired,
+    ServerUnavailable,
+    SlowDown,
+    TemporaryFailure,
+)
+from .requests import Request
+from .responses import Input, Link, Redirect, Response
+
+__all__ = [
+    # Main application
+    "Xitzin",
+    # Request/Response
+    "Request",
+    "Response",
+    "Input",
+    "Redirect",
+    "Link",
+    # CGI support
+    "CGIConfig",
+    "CGIHandler",
+    "CGIScript",
+    # Exceptions
+    "GeminiException",
+    "InputRequired",
+    "SensitiveInputRequired",
+    "TemporaryFailure",
+    "ServerUnavailable",
+    "CGIError",
+    "ProxyError",
+    "SlowDown",
+    "PermanentFailure",
+    "NotFound",
+    "Gone",
+    "ProxyRequestRefused",
+    "BadRequest",
+    "CertificateRequired",
+    "CertificateNotAuthorized",
+    "CertificateNotValid",
+]
+
+__version__ = "0.1.0"