Installation
============

Requirements
------------

* Python 3.10 or higher
* pip or uv package manager

Basic Installation
------------------

Install Gobstopper using uv (recommended):

.. code-block:: bash

   uv add gobstopper

Or using pip:

.. code-block:: bash

   pip install gobstopper

Optional Dependencies
---------------------

Gobstopper uses optional dependencies to keep the core lightweight:

Templates
^^^^^^^^^

For Jinja2 template support:

.. code-block:: bash

   uv add "gobstopper[templates]"

Background Tasks
^^^^^^^^^^^^^^^^

For DuckDB-backed background task system:

.. code-block:: bash

   uv add "gobstopper[tasks]"

CLI Tools
^^^^^^^^^

For command-line tools and project generation:

.. code-block:: bash

   uv add "gobstopper[cli]"

Charts
^^^^^^

For data visualization support:

.. code-block:: bash

   uv add "gobstopper[charts]"

Session Backends
^^^^^^^^^^^^^^^^

For Redis session storage:

.. code-block:: bash

   uv add "gobstopper[redis]"

For PostgreSQL session storage:

.. code-block:: bash

   uv add "gobstopper[postgres]"

Development Tools
^^^^^^^^^^^^^^^^^

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

.. code-block:: bash

   uv add "gobstopper[dev]"

All Features
^^^^^^^^^^^^

To install all optional features:

.. code-block:: bash

   uv add "gobstopper[all]"

Verifying Installation
-----------------------

Verify your installation:

.. code-block:: bash

   uv run gobstopper version

You should see output like:

.. code-block:: text

   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:

.. code-block:: bash

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

Next Steps
----------

* :doc:`quickstart` - Get started with your first Gobstopper application
* :doc:`tutorial/index` - Follow the complete tutorial
* :doc:`cli` - Learn about the CLI tools