Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/encode/orm
An async ORM. 🗃
https://github.com/encode/orm
Last synced: 1 day ago
JSON representation
An async ORM. 🗃
- Host: GitHub
- URL: https://github.com/encode/orm
- Owner: encode
- License: bsd-3-clause
- Created: 2019-02-12T16:51:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-30T10:12:31.000Z (over 2 years ago)
- Last Synced: 2024-12-05T19:02:27.914Z (8 days ago)
- Language: Python
- Homepage: https://www.encode.io/orm
- Size: 496 KB
- Stars: 1,785
- Watchers: 42
- Forks: 98
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-fastapi - ORM - An async ORM. (Third-Party Extensions / Databases)
- awesome-fastapi - ORM - An async ORM. (Third-Party Extensions / Databases)
README
# ORM
The `orm` package is an async ORM for Python, with support for Postgres,
MySQL, and SQLite. ORM is built with:
* [SQLAlchemy core][sqlalchemy-core] for query building.
* [`databases`][databases] for cross-database async support.
* [`typesystem`][typesystem] for data validation.
Because ORM is built on SQLAlchemy core, you can use Alembic to provide
database migrations.
---
**Documentation**: [https://www.encode.io/orm](https://www.encode.io/orm)
---
## Installation
```shell
$ pip install orm
```
You can install the required database drivers with:
```shell
$ pip install orm[postgresql]
$ pip install orm[mysql]
$ pip install orm[sqlite]
```
Driver support is provided using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
---
## Quickstart
**Note**: Use `ipython` to try this from the console, since it supports `await`.
```python
import databases
import orm
database = databases.Database("sqlite:///db.sqlite")
models = orm.ModelRegistry(database=database)
class Note(orm.Model):
tablename = "notes"
registry = models
fields = {
"id": orm.Integer(primary_key=True),
"text": orm.String(max_length=100),
"completed": orm.Boolean(default=False),
}
# Create the tables
await models.create_all()
await Note.objects.create(text="Buy the groceries.", completed=False)
note = await Note.objects.get(id=1)
print(note)
# Note(id=1)
```
— 🗃 —
ORM is BSD licensed code. Designed & built in Brighton, England.
[sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
[asyncpg]: https://github.com/MagicStack/asyncpg
[aiomysql]: https://github.com/aio-libs/aiomysql
[aiosqlite]: https://github.com/jreese/aiosqlite
[databases]: https://github.com/encode/databases
[typesystem]: https://github.com/encode/typesystem
[typesystem-fields]: https://www.encode.io/typesystem/fields/