{"id":34085728,"url":"https://github.com/ibonn/tatami","last_synced_at":"2026-04-03T08:38:44.830Z","repository":{"id":306568746,"uuid":"1023856929","full_name":"ibonn/tatami","owner":"ibonn","description":"The clean, modular Python web floorplan","archived":false,"fork":false,"pushed_at":"2025-08-01T19:17:26.000Z","size":1003,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-10T02:33:54.998Z","etag":null,"topics":["developer-experience","framework","python","python3","rest-api","web-framework"],"latest_commit_sha":null,"homepage":"https://ibonn.github.io/tatami","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ibonn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-21T19:59:47.000Z","updated_at":"2025-08-05T01:22:09.000Z","dependencies_parsed_at":"2025-07-26T14:49:00.373Z","dependency_job_id":"6b104c31-0955-422c-aa98-07d7c60dcd3f","html_url":"https://github.com/ibonn/tatami","commit_stats":null,"previous_names":["ibonn/tatami"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/ibonn/tatami","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibonn%2Ftatami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibonn%2Ftatami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibonn%2Ftatami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibonn%2Ftatami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ibonn","download_url":"https://codeload.github.com/ibonn/tatami/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ibonn%2Ftatami/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27728920,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-12-14T02:00:11.348Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["developer-experience","framework","python","python3","rest-api","web-framework"],"created_at":"2025-12-14T13:11:58.298Z","updated_at":"2025-12-14T13:11:59.334Z","avatar_url":"https://github.com/ibonn.png","language":"Python","readme":"![Tatami Logo](https://raw.githubusercontent.com/ibonn/tatami/refs/heads/main/docs/source/_static/tatami-logo-gradient.png)\n\n![Build Status](https://img.shields.io/github/actions/workflow/status/ibonn/tatami/pypi-publish.yml?style=flat-square)\n![Docs Status](https://img.shields.io/github/actions/workflow/status/ibonn/tatami/gh-pages.yml?label=docs\u0026style=flat-square)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/tatami?style=flat-square)\n![PyPI - Version](https://img.shields.io/pypi/v/tatami?style=flat-square)\n\n---\n\n**The clean, modular Python web floorplan.**\n\nTatami is a minimal, convention-powered web framework that builds your application from the ground up — guided by your directory structure, not boilerplate or ceremony.\n\nLike traditional *tatami* mats that structure a Japanese room, Tatami lets you define the shape and flow of your web app naturally, simply by laying things out.\n\n---\n\n## ✨ Features\n\n- 🔁 **Automatic routing** from file and folder structure\n- 📦 **Service injection** via convention\n- 🧩 **Auto-loaded middleware**, templates, and static assets\n- 📖 **Live OpenAPI docs** (ReDoc, Swagger, RapiDoc)\n- 🧠 **Auto-generated endpoint documentation** from docstrings and README\n- ⚡ **Zero-config startup** — just run your app directory\n\n---\n\n## 🚀 Quick Start\n\n```bash\npip install tatami\n```\n\n**Create a new project:**\n```bash\ntatami create myproject\n```\n\n**Run your project:**\n```bash\ntatami run myproject\n```\n\nYour API will be available at `http://localhost:8000` with automatic docs at `/docs/swagger`.\n\n## 🧠 Philosophy\n\nTatami is designed for:\n\n* Structure-first design: Routes and services emerge from file layout.\n* Simplicity: Eliminate configuration and glue code.\n* Alignment: Your docs, code, and architecture reflect each other.\n\nIt's like FastAPI and Flask had a minimalist, Spring Boot-inspired child.\n\n## 📚 Documentation\nYou can access the whole documentation for Tatami [here](https://ibonn.github.io/tatami/)\n\nBy the way, Tatami automatically generates your application’s documentation at the following endpoints:\n- `/openapi.json` - OpenAPI specification\n- `/docs/swagger` - Swagger UI\n- `/docs/redoc` - ReDoc\n- `/docs/rapidoc` - RapiDoc\n\n## 🔌 Example\n\n**Using decorators (recommended):**\n```python\nfrom tatami import get, post, router\nfrom pydantic import BaseModel\n\nclass User(BaseModel):\n    name: str\n    age: int\n\nclass Users(router('/users')):\n    @get('/')\n    def list_users(self):\n        \"\"\"Returns all users in the system.\"\"\"\n        return [{\"id\": 1, \"name\": \"Alice\", \"age\": 30}]\n\n    @post('/')\n    def create_user(self, user: User):\n        \"\"\"Creates a new user.\"\"\"\n        return {\"message\": f\"Created user {user.name}\"}\n\n    @get('/{user_id}')\n    def get_user(self, user_id: int):\n        \"\"\"Get a specific user by ID.\"\"\"\n        return {\"id\": user_id, \"name\": \"Alice\", \"age\": 30}\n```\n\n**Using convention-based routing:**\n```python\n# In routers/users.py\nclass Users:\n    def get_users(self):\n        \"\"\"List all users\"\"\"\n        return [{\"id\": 1, \"name\": \"Alice\"}]\n    \n    def post_user(self, user: User):\n        \"\"\"Create a new user\"\"\"\n        return {\"created\": user.name}\n```\n\nThis automatically creates:\n* GET /users/\n* POST /users/\n* GET /users/{user_id}\n\n...with full OpenAPI schemas generated automatically.\n\n## 🌱 Still Early\n\nTatami is experimental. Expect breaking changes, rapid iteration, and exciting ideas.\n\nContributions, feedback, and issue reports are more than welcome.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibonn%2Ftatami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fibonn%2Ftatami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fibonn%2Ftatami/lists"}