Skip to main content

Documentation Index

Fetch the complete documentation index at: https://abxbus.archivebox.io/llms.txt

Use this file to discover all available pages before exploring further.

Set up the Python development environment using uv:
git clone https://github.com/ArchiveBox/abxbus && cd abxbus

# Create virtual environment with Python 3.12
uv venv --python 3.12

# Activate virtual environment (varies by OS)
source .venv/bin/activate  # On Unix/macOS
# or
.venv\Scripts\activate  # On Windows

# Install dependencies
uv sync --dev --all-extras
Recommended once per clone:
prek install           # install pre-commit hooks
prek run --all-files   # run pre-commit hooks on all files manually

# Run linter & type checker
uv run ruff check --fix
uv run ruff format
uv run pyright

# Run all tests
uv run pytest -vxs --full-trace tests/

# Run specific test file
uv run pytest tests/test_eventbus.py

# Run Python perf test suite
uv run pytest tests/test_eventbus_performance.py -vxs

# Run the entire lint+test+examples+perf suite for both Python and TS
./test.sh
For AbxBus-TS development see the abxbus-ts/README.md # Development section.