Installation

Requirements

  • Python 3.10 or higher

  • pip or uv package manager

Basic Installation

Install Gobstopper using uv (recommended):

uv add gobstopper

Or using pip:

pip install gobstopper

Optional Dependencies

Gobstopper uses optional dependencies to keep the core lightweight:

Templates

For Jinja2 template support:

uv add "gobstopper[templates]"

Background Tasks

For DuckDB-backed background task system:

uv add "gobstopper[tasks]"

CLI Tools

For command-line tools and project generation:

uv add "gobstopper[cli]"

Charts

For data visualization support:

uv add "gobstopper[charts]"

Session Backends

For Redis session storage:

uv add "gobstopper[redis]"

For PostgreSQL session storage:

uv add "gobstopper[postgres]"

Development Tools

For development dependencies (pytest, black, ruff, mypy):

uv add "gobstopper[dev]"

All Features

To install all optional features:

uv add "gobstopper[all]"

Verifying Installation

Verify your installation:

uv run gobstopper version

You should see output like:

Gobstopper v0.1.0
High-performance async web framework
Built for Granian's RSGI interface

Installing from Source

To install from source with Rust extensions:

git clone https://github.com/gobstopper-framework/gobstopper.git
cd gobstopper
uv sync
uv run python dev_install_rust.py --strip

Next Steps