Skip to content

Commit cbc9f8f

Browse files
committed
readme: minor refine
1 parent f63904f commit cbc9f8f

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,14 @@
11
SQLAlchemy-Nested-Mutable
22
=========================
33

4-
```shell
5-
pip install sqlalchemy-nested-mutable
6-
```
7-
84
An advanced SQLAlchemy column type factory that helps map compound Python types (e.g. `list`, `dict`, *Pydantic Model* and their hybrids) to database types (e.g. `ARRAY`, `JSONB`),
95
And keep track of mutations in deeply nested data structures so that SQLAlchemy can emit proper *UPDATE* statements.
106

117
SQLAlchemy-Nested-Mutable is highly inspired by SQLAlchemy-JSON<sup>[[0]](https://github.com/edelooff/sqlalchemy-json)</sup><sup>[[1]](https://variable-scope.com/posts/mutation-tracking-in-nested-json-structures-using-sqlalchemy)</sup>.
128
However, it does not limit the mapped Python type to be `dict` or `list`.
139

10+
---
11+
1412
## Why this package?
1513

1614
* By default, SQLAlchemy does not track in-place mutations for non-scalar data types
@@ -27,6 +25,12 @@ However, it does not limit the mapped Python type to be `dict` or `list`.
2725
which have strong schemas, with the db type be schema-less JSON.
2826

2927

28+
## Installation
29+
30+
```shell
31+
pip install sqlalchemy-nested-mutable
32+
```
33+
3034
## Usage
3135

3236
> NOTE the example below is first updated in `examples/user-addresses.py` and then updated here.

0 commit comments

Comments
 (0)