Easy async ORM for python, built with relations in mind.
Project description
postmodel
Introduction
Postmodel is an easy-to-use asyncio
ORM (Object Relational Mapper) inspired by Django and Tortoise ORM.
Postmodel provides 90% Django ORM like API, to ease the migration of developers wishing to switch to asyncio
.
Currently, Postmodel provides following features:
- full active-record pattern
- optimistic locking
- 100% code coverage
But, it still have some limits:
- only support Postgresql
- no planing support SQLite, instead it will supports RediSQL
- no support relation
Postmodel is supported on CPython >= 3.6 for PostgreSQL.
Getting Started
Installation
You have to install postmodel like this:
pip install postmodel
Quick Tutorial
Primary entity of postmodel is postmodel.models.Model
.
You can start writing models like this:
from postmodel import models
class Book(models.Model):
id = models.IntField(pk=True)
name = models.TextField()
tag = models.CharField(max_length=120)
class Meta:
table = "book_test"
def __str__(self):
return self.name
After you defined all your models, postmodel needs you to init them, in order to create backward relations between models and match your db client with appropriate models.
You can do it like this:
from postmodel import Postmodel
async def init():
# Here we connect to a PostgreSQL DB.
# also specify the app name of "models"
# which contain models from "app.models"
await Postmodel.init(
'postgres://postgres@localhost:54320/test_db',
modules= [__name__]
)
# Generate the schema
await Postmodel.generate_schemas()
Here we create connection to Postgres database, and then we discover & initialise models.
Postmodel currently supports the following databases:
- PostgreSQL (requires
asyncpg
)
generate_schema
generates the schema on an empty database. Postmodel generates schemas in safe mode by default which
includes the IF NOT EXISTS
clause, so you may include it in your main code.
After that you can start using your models:
# Create instance by save
book = Book(id=1, name='Mastering postmdel', tag="orm")
await book.save()
# Or by .create()
await Book.create(id=2, name='Learning Python', tag="python")
# Query
books = await Book.filter(tag="orm").all()
assert len(books) == 1
Contributing
Please have a look at the Contribution Guide <docs/CONTRIBUTING.md>
_
License
This project is licensed under the MIT License - see the LICENSE <LICENSE>
_ file for details
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file postmodel-0.3.0.tar.gz
.
File metadata
- Download URL: postmodel-0.3.0.tar.gz
- Upload date:
- Size: 28.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52cbffd1327157bf8f930abf46df8d7ce8378588a7ac43109b4558fcffca331b |
|
MD5 | 58274eedeead489d74e7d91ad0a831d3 |
|
BLAKE2b-256 | 940fd37eeb35cc33a70886e4bc5960046b69c3c0a34c8797d3456cfb5b3077b3 |
File details
Details for the file postmodel-0.3.0-py3-none-any.whl
.
File metadata
- Download URL: postmodel-0.3.0-py3-none-any.whl
- Upload date:
- Size: 31.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b133b8d9cd987d576f6287c087b6d7d2f5fbd486949b8633dbf51e5e3bce8fd |
|
MD5 | 2834ce4f054d3b7efab3fdc738a47a41 |
|
BLAKE2b-256 | f85a3c451f7b04d238759a54460e6e8bbad958ec2425fc6c4cafc35b9b87c593 |