Metadata-Version: 2.4
Name: bbannotate
Version: 1.0.6
Summary: A lightweight bounding box annotation tool for image datasets with YOLO/COCO/Pascal VOC export
Project-URL: Homepage, https://github.com/seba2390/bbannotate
Project-URL: Documentation, https://github.com/seba2390/bbannotate#readme
Project-URL: Repository, https://github.com/seba2390/bbannotate
Project-URL: Issues, https://github.com/seba2390/bbannotate/issues
Author: Sebastian Yde Madsen
License-Expression: MIT
License-File: LICENSE
Keywords: annotation,bounding-box,coco,computer-vision,image-annotation,machine-learning,object-detection,pascal-voc,yolo
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: FastAPI
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Typing :: Typed
Requires-Python: >=3.12
Requires-Dist: aiofiles>=23.2.1
Requires-Dist: fastapi>=0.109.0
Requires-Dist: pillow>=10.2.0
Requires-Dist: pydantic>=2.5.0
Requires-Dist: python-multipart>=0.0.6
Requires-Dist: rich>=13.0.0
Requires-Dist: slowapi>=0.1.9
Requires-Dist: typer>=0.9.0
Requires-Dist: uvicorn[standard]>=0.27.0
Provides-Extra: dev
Requires-Dist: httpx; extra == 'dev'
Requires-Dist: pyright; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Description-Content-Type: text/markdown

  Bbannotate Logo

A lightweight bounding box annotation tool for image datasets. Built with React/TypeScript frontend and FastAPI backend. Export to YOLO, COCO, Pascal VOC, and more.

## Features

- 🖼️ **Multi-format support** — PNG, JPEG, WebP, BMP
- 📁 **Project management** — Organize annotations by project
- 🏷️ **Custom labels** — Define your own class labels
- ⌨️ **Keyboard shortcuts** — Fast annotation workflow
- 📤 **Multiple export formats** — YOLO, COCO, Pascal VOC, CreateML, CSV
- 🔄 **Train/Val/Test split** — Automatic dataset splitting for YOLO export

## Installation

```bash
pip install bbannotate
```

### Requirements

- Python 3.12+
- Node.js (only for frontend development)

## Quick Start

```bash
# Start the annotation server
bbannotate start

# Opens http://127.0.0.1:8000 in your browser
```

### CLI Options

```bash
bbannotate start [OPTIONS]

Options:
  -h, --host TEXT        Host to bind the server to [default: 127.0.0.1]
  -p, --port INTEGER     Port to bind the server to [default: 8000]
  --no-browser           Don't open browser automatically
  -r, --reload           Enable auto-reload for development
  -d, --data-dir PATH    Directory for storing data [default: ./data]
  --projects-dir PATH    Directory for storing projects [default: ./projects]
  -v, --version          Show version and exit
  --help                 Show help and exit
```

### Other Commands

```bash
bbannotate info            # Show installation info
bbannotate build-frontend  # Build frontend assets (development)
```

## Keyboard Shortcuts

| Key | Action |
|-----|--------|
| `D` | Draw mode |
| `S` | Select mode |
| `Space` | Pan mode |
| `←` `→` | Navigate images |
| `1-9` | Select label by index |
| `Del` / `Backspace` | Delete annotation |
| `⌘Z` / `Ctrl+Z` | Undo last annotation |
| `Esc` | Deselect / Cancel |

## Export Formats

| Format | Description |
|--------|-------------|
| **YOLO** | ZIP with train/val/test split, `data.yaml`, normalized coordinates |
| **COCO** | COCO JSON format with categories, images, and annotations |
| **Pascal VOC** | XML files per image with absolute coordinates |
| **CreateML** | Apple CreateML JSON format |
| **CSV** | Simple CSV with image, label, and bbox columns |

## Configuration

### Environment Variables

| Variable | Description |
|----------|-------------|
| `BBANNOTATE_DATA_DIR` | Override default data directory |
| `BBANNOTATE_PROJECTS_DIR` | Override default projects directory |
| `BBANNOTATE_UPLOAD_RATE_LIMIT` | Upload rate limit (default: `1000/minute`) |

## Development

### Setup

```bash
git clone https://github.com/sebastianydemadsen/bbannotate.git
cd bbannotate
make install        # Install with dev dependencies
make frontend-install  # Install frontend dependencies
```

### Development Commands

| Command | Description |
|---------|-------------|
| `make run` | Start full application (backend + frontend) |
| `make backend-dev` | Start backend only with auto-reload |
| `make frontend-dev` | Start frontend dev server |
| `make stop` | Stop all servers |
| `make test` | Run tests |
| `make test-cov` | Run tests with coverage report |
| `make type-check` | Run pyright type checking |
| `make format` | Format code with ruff |
| `make check-all` | Run all checks (lint, type, test) |
| `make build` | Build package for distribution |
| `make clean` | Remove build artifacts |

### Project Structure

```
src/               # Python package (FastAPI backend)
  api/             # API routes
  models/          # Pydantic models
  services/        # Business logic
  cli.py           # CLI entry point
frontend/          # React/TypeScript frontend
  src/
    components/    # UI components
    hooks/         # React hooks
tests/             # Test suite (145 tests)
```

## License

[MIT](LICENSE)
