Skip to content

docs: fix readme facts and license metadata #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lesnik512 merged 2 commits into from
Oct 3, 2026
Merged

docs: fix readme facts and license metadata #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47fff51
docs: fix readme facts and license metadata
lesnik512 Oct 3, 2026
ef1932c
docs: drop the em dash from the org footer
lesnik512 Oct 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]",
Expand Down
16 changes: 7 additions & 9 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,26 @@
[![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`

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.
Loading