From a331908a22b6599b402af1d91c72bdec4762659b Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 13 Jun 2026 18:08:02 +0300 Subject: [PATCH 1/2] docs: standardize README header and footer Aligns with the modern-python uniform-README standard. Co-Authored-By: Claude Opus 4.8 (1M context) --- readme.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index 0c0ac75..37e110b 100644 --- a/readme.md +++ b/readme.md @@ -1,9 +1,13 @@ -## Async template on LiteStar and SQLAlchemy 2 +# litestar-sqlalchemy-template -[![Test Coverage](https://codecov.io/gh/modern-python/litestar-sqlalchemy-template/branch/main/graph/badge.svg)](https://codecov.io/gh/modern-python/litestar-sqlalchemy-template) -[![GitHub issues](https://img.shields.io/github/issues/modern-python/litestar-sqlalchemy-template)](https://github.com/modern-python/litestar-sqlalchemy-template/issues) -[![GitHub forks](https://img.shields.io/github/forks/modern-python/litestar-sqlalchemy-template)](https://github.com/modern-python/litestar-sqlalchemy-template/network) +[![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen.svg)](https://github.com/modern-python/litestar-sqlalchemy-template/actions/workflows/main.yml) +[![CI](https://github.com/modern-python/litestar-sqlalchemy-template/actions/workflows/main.yml/badge.svg)](https://github.com/modern-python/litestar-sqlalchemy-template/actions/workflows/main.yml) +[![License](https://img.shields.io/github/license/modern-python/litestar-sqlalchemy-template.svg)](https://github.com/modern-python/litestar-sqlalchemy-template/blob/main/LICENSE) [![GitHub stars](https://img.shields.io/github/stars/modern-python/litestar-sqlalchemy-template)](https://github.com/modern-python/litestar-sqlalchemy-template/stargazers) +[![Context7](https://img.shields.io/badge/Context7-docs-blue)](https://context7.com/modern-python/litestar-sqlalchemy-template) +[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv) +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty) ### Description Production-ready dockerized async REST API on LiteStar with SQLAlchemy and PostgreSQL @@ -22,8 +26,9 @@ You can clone this project or use [this template](https://github.com/modern-pyth just --list ``` +## 📝 [License](LICENSE) + ## Part of `modern-python` Browse the full list of templates and libraries in -[`modern-python`](https://github.com/modern-python) — see the org profile for the -categorized index. +[`modern-python`](https://github.com/modern-python) — see the org profile for the categorized index. From f00ce32230f7541185b6944f81c9c3b80f9d66e8 Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 13 Jun 2026 19:00:00 +0300 Subject: [PATCH 2/2] docs: drop Context7 badge (not needed for template) Co-Authored-By: Claude Opus 4.8 (1M context) --- readme.md | 1 - 1 file changed, 1 deletion(-) diff --git a/readme.md b/readme.md index 37e110b..56c14f9 100644 --- a/readme.md +++ b/readme.md @@ -4,7 +4,6 @@ [![CI](https://github.com/modern-python/litestar-sqlalchemy-template/actions/workflows/main.yml/badge.svg)](https://github.com/modern-python/litestar-sqlalchemy-template/actions/workflows/main.yml) [![License](https://img.shields.io/github/license/modern-python/litestar-sqlalchemy-template.svg)](https://github.com/modern-python/litestar-sqlalchemy-template/blob/main/LICENSE) [![GitHub stars](https://img.shields.io/github/stars/modern-python/litestar-sqlalchemy-template)](https://github.com/modern-python/litestar-sqlalchemy-template/stargazers) -[![Context7](https://img.shields.io/badge/Context7-docs-blue)](https://context7.com/modern-python/litestar-sqlalchemy-template) [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) [![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)