.. Gobstopper documentation master file

Gobstopper Web Framework Documentation
=================================

**Gobstopper** is a production-ready, high-performance async web framework built specifically for Granian's RSGI interface.
Gobstopper combines the developer experience of Flask/Quart with the performance benefits of RSGI and optional Rust-powered components.

.. image:: https://img.shields.io/badge/version-0.1.0-blue.svg
   :target: https://pypi.org/project/gobstopper
   :alt: Version

.. image:: https://img.shields.io/badge/python-3.10+-blue.svg
   :target: https://www.python.org/downloads/
   :alt: Python Version

.. image:: https://img.shields.io/badge/license-MIT-green.svg
   :target: https://opensource.org/licenses/MIT
   :alt: License

Quick Start
-----------

Installation
^^^^^^^^^^^^

.. code-block:: bash

   # Basic installation (core framework only)
   uv add gobstopper

   # With all optional features
   uv add "gobstopper[all]"

   # For development
   uv add "gobstopper[dev]"

Hello World
^^^^^^^^^^^

.. code-block:: python

   from gobstopper import Gobstopper, Request, jsonify

   app = Gobstopper(__name__)

   @app.get("/")
   async def hello(request: Request):
       return jsonify({"message": "Hello from Gobstopper!"})

   # Run with: gobstopper run --reload

Key Features
------------

🦀 **Rust-Powered Components**
   High-performance routing, templates, and static file serving with seamless Python fallback

⚡ **RSGI Native**
   Purpose-built for Granian's high-performance RSGI interface

🔋 **Batteries Included**
   Background tasks, WebSockets, sessions, and security out-of-the-box

🎨 **Flask-like API**
   Familiar, ergonomic API design with modern async/await

📦 **Lightweight Core**
   Install only what you need with optional dependencies

Table of Contents
-----------------

.. toctree::
   :maxdepth: 2
   :caption: User Guide

   installation
   quickstart
   cli
   configuration
   blueprints

.. toctree::
   :maxdepth: 2
   :caption: Core Components

   core_docs/application
   core_docs/http
   core_docs/middleware
   core_docs/background_tasks
   core_docs/websockets

.. toctree::
   :maxdepth: 2
   :caption: Advanced Topics

   performance_tuning
   security_best_practices

.. toctree::
   :maxdepth: 2
   :caption: API Reference

   api/index

.. toctree::
   :maxdepth: 1
   :caption: Additional Information

   changelog
   contributing
   license

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`