Skip to content

Commit 3228f2c

Browse files
authored
docs: fix readme facts and license metadata (#76)
* 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 * docs: drop the em dash from the org footer
1 parent 0ffb4dc commit 3228f2c

2 files changed

Lines changed: 8 additions & 10 deletions

File tree

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ requires-python = ">=3.14"
77
authors = [
88
{ name = "Artur Shiriev", email = "me@shiriev.ru" },
99
]
10-
license = "MIT License"
10+
license = "MIT"
1111
dependencies = [
1212
"fastapi>=0.76",
1313
"lite-bootstrap[fastapi-all]",

‎readme.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,26 @@
1414
[![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)
1515
[![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)
1616

17-
### Description
18-
Production-ready dockerized async REST API on FastAPI with SQLAlchemy and PostgreSQL
17+
## Description
18+
Dockerized FastAPI, SQLAlchemy 2 and PostgreSQL app template with DI.
1919

20-
## Key Features
20+
## Key features
2121
- tests on `pytest` with automatic rollback after each test case
2222
- IOC (Inversion of Control) container built on [modern-di](https://github.com/modern-python/modern-di/)
2323
- Observability tools integration built on [lite-bootstrap](https://github.com/modern-python/lite-bootstrap/)
24-
- Linting and formatting using `ruff` and `ty`
24+
- Linting and formatting with `ruff`, type checking with `ty`
2525
- `Alembic` for DB migrations
2626

2727
Authentication is intentionally omitted: pick the scheme that fits your project and add it as a FastAPI dependency.
2828

29-
You can clone this project or use [this template](https://github.com/modern-python/modern-python-template) for fast [micro]service creation from scratch.
30-
31-
### After `git clone` run
29+
## After `git clone` run
3230
```bash
3331
just --list
3432
```
3533

36-
## 📝 [License](LICENSE)
34+
## 📝 [License](https://github.com/modern-python/fastapi-sqlalchemy-template/blob/main/LICENSE)
3735

3836
## Part of `modern-python`
3937

4038
Browse the full list of templates and libraries in
41-
[`modern-python`](https://github.com/modern-python) — see the org profile for the categorized index.
39+
[`modern-python`](https://github.com/modern-python); the org profile has the categorized index.

0 commit comments

Comments
 (0)