Pastebin

A FastAPI service for code sharing.

Prerequisites

• uv (fast Python package installer and resolver)
• Python 3.12 (managed automatically by uv)

Setup & Running

1. Clone the repository

git clone https://github.com/sparrowsurya/pastebin-api

2. Environment Configuration (Optional)

The project comes pre-configured with default settings using a local SQLite database (sqlite:///./db.sqlite3), so creating a .env file is optional for local development and testing.

To override settings locally, you can create/modify .env.dev:

ENV_NAME=dev
BASE_URL=127.0.0.1:8000
DB_URL=sqlite:///./db.sqlite3
INTERVAL=3600

Note

When running on Vercel, the application dynamically ignores the local env files and relies directly on Environment Variables configured in your Vercel Dashboard settings. Use .env.prod purely as a local template reference.

3. Sync dependencies

Installs the locked dependencies into a local virtual environment:

uv sync

4. Run the API

Start the application using uvicorn:

uv run uvicorn api.main:app --log-config=log_config.json

---

Running Tests

Run the test suite via the builtin unittest framework:

uv run python -m unittest discover

Linting, Formatting & Type Checking

To lint the codebase with Ruff:

uv run ruff check

To auto-format the codebase with Ruff:

uv run ruff format

To type-check the codebase with mypy:

uv run mypy api