From 47fff5153236b5f9fbe2187c154ca203da7af5fe Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 3 Oct 2026 16:01:02 +0300 Subject: [PATCH 1/2] docs: fix readme facts and license metadata - Drop the link to modern-python-template, which does not exist - Open the description with the pyproject description - Separate linting/formatting (ruff) from type checking (ty) - Use an absolute LICENSE link like the other org repos - Sentence-case headings and fix the skipped heading level - Use the SPDX id "MIT" for the pyproject license --- pyproject.toml | 2 +- readme.md | 14 ++++++-------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index a2d5ede..730a23e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ requires-python = ">=3.14" authors = [ { name = "Artur Shiriev", email = "me@shiriev.ru" }, ] -license = "MIT License" +license = "MIT" dependencies = [ "litestar", "lite-bootstrap[litestar-all]", diff --git a/readme.md b/readme.md index dde5a5b..f64ec62 100644 --- a/readme.md +++ b/readme.md @@ -14,26 +14,24 @@ [![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 +## Description +Dockerized Litestar, SQLAlchemy 2 and PostgreSQL app template with DI. -## Key Features +## Key features - tests on `pytest` with automatic rollback after each test case - IOC (Inversion of Control) container built on [modern-di](https://github.com/modern-python/modern-di/) - Observability tools integration built on [lite-bootstrap](https://github.com/modern-python/lite-bootstrap/) -- Linting and formatting using `ruff` and `ty` +- Linting and formatting with `ruff`, type checking with `ty` - `Alembic` for DB migrations Authentication is intentionally omitted: pick the scheme that fits your project and add it as a Litestar guard or middleware. -You can clone this project or use [this template](https://github.com/modern-python/modern-python-template) for fast [micro]service creation from scratch. - -### After `git clone` run +## After `git clone` run ```bash just --list ``` -## 📝 [License](LICENSE) +## 📝 [License](https://github.com/modern-python/litestar-sqlalchemy-template/blob/main/LICENSE) ## Part of `modern-python` From ef1932c23f63bb96508fe5693222ca154ec4b8f4 Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sat, 3 Oct 2026 16:02:24 +0300 Subject: [PATCH 2/2] docs: drop the em dash from the org footer --- readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readme.md b/readme.md index f64ec62..06e0c01 100644 --- a/readme.md +++ b/readme.md @@ -36,4 +36,4 @@ just --list ## 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); the org profile has the categorized index.