Skip to content

README.md

Latest commit

 

History

History
60 lines (42 loc) · 1.1 KB

README.md

File metadata and controls

60 lines (42 loc) · 1.1 KB
Raw

BleepStore — Python Implementation

An S3-compatible object store implemented in Python using FastAPI.

Prerequisites

  • Python 3.11+
  • uv package manager

Quick Start

# Setup
cd python/
uv venv .venv && source .venv/bin/activate
uv pip install -e ".[dev]"

# Run
bleepstore --config ../bleepstore.example.yaml --port 9010

Documentation

  • Deployment Guide - Full deployment instructions including Docker, systemd, and production considerations

Testing

# Unit tests
uv run pytest tests/ -v

# E2E tests (requires running server)
./run_e2e.sh

Development

# Type checking
uv run mypy src/bleepstore/

# Linting
uv run ruff check src/
uv run ruff format src/

Configuration

See bleepstore.example.yaml for configuration options.

Endpoints

Endpoint Description
/ S3 API
/docs Swagger UI
/openapi.json OpenAPI spec
/metrics Prometheus metrics
/healthz Liveness probe
/readyz Readiness probe