From b3cc2ba86b517f60114833f629e888dffacd81ce Mon Sep 17 00:00:00 2001 From: collerek Date: Fri, 14 Aug 2020 19:39:47 +0200 Subject: [PATCH] renames in readme --- .gitignore | 3 ++- README.md | 38 +++++++++++++++++++------------------- 2 files changed, 21 insertions(+), 20 deletions(-) diff --git a/.gitignore b/.gitignore index 22d9e75..f58fa36 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ p38venv *.pyc *.log test.db -dist \ No newline at end of file +dist +/ormar.egg-info/ diff --git a/README.md b/README.md index d72c80b..0eca573 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# Async-ORM +# ORMar

Build Status - Coverage + Coverage CodeFactor @@ -15,21 +15,21 @@

-The `async-orm` package is an async ORM for Python, with support for Postgres, -MySQL, and SQLite. ORM is built with: +The `ormar` package is an async ORM for Python, with support for Postgres, +MySQL, and SQLite. Ormar is built with: * [`SQLAlchemy core`][sqlalchemy-core] for query building. * [`databases`][databases] for cross-database async support. * [`pydantic`][pydantic] for data validation. -Because ORM is built on SQLAlchemy core, you can use [`alembic`][alembic] to provide +Because ormar is built on SQLAlchemy core, you can use [`alembic`][alembic] to provide database migrations. -The goal was to create a simple orm that can be used directly with [`fastapi`][fastapi] that bases it's data validation on pydantic. +The goal was to create a simple ormar that can be used directly with [`fastapi`][fastapi] that bases it's data validation on pydantic. Initial work was inspired by [`encode/orm`][encode/orm]. The encode package was too simple (i.e. no ability to join two times to the same table) and used typesystem for data checks. -**async-orm is still under development:** We recommend pinning any dependencies with `aorm~=0.0.1` +**ormar is still under development:** We recommend pinning any dependencies with `ormar~=0.1.1` **Note**: Use `ipython` to try this from the console, since it supports `await`. @@ -84,7 +84,7 @@ note = await Note.objects.get(pk=2) note.pk # 2 ``` -ORM supports loading and filtering across foreign keys... +Ormar supports loading and filtering across foreign keys... ```python import databases @@ -181,17 +181,17 @@ All fields are required unless one of the following is set: Autoincrement is set by default on int primary keys. Available Model Fields: -* `orm.String(length)` -* `orm.Text()` -* `orm.Boolean()` -* `orm.Integer()` -* `orm.Float()` -* `orm.Date()` -* `orm.Time()` -* `orm.DateTime()` -* `orm.JSON()` -* `orm.BigInteger()` -* `orm.Decimal(lenght, precision)` +* `String(length)` +* `Text()` +* `Boolean()` +* `Integer()` +* `Float()` +* `Date()` +* `Time()` +* `DateTime()` +* `JSON()` +* `BigInteger()` +* `Decimal(lenght, precision)` [sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/ [databases]: https://github.com/encode/databases