Skip to main content

A simple todo list REST API

Project description

Todo List REST API

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

Installation

uv sync

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

todo_rest-0.1.4.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

todo_rest-0.1.4-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file todo_rest-0.1.4.tar.gz.

File metadata

  • Download URL: todo_rest-0.1.4.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for todo_rest-0.1.4.tar.gz
Algorithm Hash digest
SHA256 eacab5e02d88e5c82698acb072c0cb6f4ef6486d6c7325043008d7da77f962cd
MD5 820d9bdfb4c744b6cdc215de5dcb4088
BLAKE2b-256 5407b5ff6b798818ac1fdcd43b992b1181a68c6a6f57f70a80508be4c5c76dd2

See more details on using hashes here.

File details

Details for the file todo_rest-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: todo_rest-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 5.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for todo_rest-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 61e11a43ddc4cdf5bd294f8bfd65412f857c464d10f7cda7288c9bbdafef4bfc
MD5 24e6476f6be3eac9d4d2f56b41f9cc32
BLAKE2b-256 3022f938613aa38ea4bbc02c53f87ea06c3c806dc9105f448893a7bc9a1c1d2d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page