Skip to content

Installation

Cancelable requires Python 3.12+.

Quick Start

uv add hother-cancelable

pip install hother-cancelable

With Integrations

Install with optional integration groups:

# Web framework
uv add "hother-cancelable[fastapi]"

# Web framework
pip install "hother-cancelable[fastapi]"

With Examples

To run the example scripts from the repository:

uv add "hother-cancelable[examples]"

pip install "hother-cancelable[examples]"

Includes:

  • google-genai - For LLM streaming examples
  • pynput - For input monitoring examples
  • psutil - For resource monitoring

Then clone the repository and run examples:

git clone https://github.com/hotherio/cancelable.git
cd cancelable
uv run examples/01_basics/01_basic_cancelation.py

Browse all examples: Examples Documentation

Available Extras

Extra Includes Use Case
fastapi fastapi Web framework integration
examples google-genai, pynput, psutil Running example scripts from repository

Next Steps

  • Getting Started

    Learn the basics and start using Cancelable

    Get Started

  • Browse Examples

    Complete runnable examples for common use cases

    View Examples

  • Integrations

    Framework-specific integration guides

    Learn Integrations

  • API Reference

    Complete API documentation

    API Docs