todo-rest 0.2.0

A simple todo list REST API

Todo List REST API

A simple todo list application with REST endpoints and a web dashboard.

Installation

pip install todo-rest

Running the App

After installation, you can run the app with the installed command:

todo-rest

Or using the development commands:

uv run python main.py

Or with uvicorn directly (with auto-reload for development):

uv run uvicorn todo_rest.app:app --reload

The API will be available at http://localhost:8000

CLI Options

You can add artificial latency to all API requests for testing purposes:

todo-rest --latency 500

This adds a 500ms delay to all responses. Useful for testing loading states and timeouts in client applications.

Dashboard

Open http://localhost:8000 in your browser to view the todo dashboard. The dashboard shows:

• Total tasks, completed, and pending counts
• All todos with their status
• Auto-refreshes every 5 seconds

API Endpoints

Get all todos

GET /todos

Get a specific todo

GET /todos/{id}

Create a new todo

POST /todos
Content-Type: application/json

{
  "title": "Buy groceries",
  "description": "Milk, eggs, bread",
  "completed": false
}

Update a todo

PUT /todos/{id}
Content-Type: application/json

{
  "title": "Buy groceries",
  "description": "Milk, eggs, bread, cheese",
  "completed": true
}

Delete a todo

DELETE /todos/{id}

Interactive API Documentation

FastAPI provides automatic interactive documentation:

• Swagger UI: http://localhost:8000/docs
• ReDoc: http://localhost:8000/redoc