renames in readme

This commit is contained in:
collerek
2020-08-14 19:39:47 +02:00
parent 062d35168f
commit b3cc2ba86b
2 changed files with 21 additions and 20 deletions

3
.gitignore vendored
View File

@ -4,4 +4,5 @@ p38venv
*.pyc *.pyc
*.log *.log
test.db test.db
dist dist
/ormar.egg-info/

View File

@ -1,11 +1,11 @@
# Async-ORM # ORMar
<p> <p>
<a href="https://travis-ci.com/collerek/async-orm"> <a href="https://travis-ci.com/collerek/async-orm">
<img src="https://travis-ci.com/collerek/async-orm.svg?branch=master" alt="Build Status"> <img src="https://travis-ci.com/collerek/async-orm.svg?branch=master" alt="Build Status">
</a> </a>
<a href="https://codecov.io/gh/collerek/async-orm"> <a href="https://codecov.io/gh/collerek/async-orm">
<img src="https://codecov.io/gh/collerek/async-orm/branch/master/graph/badge.svg" alt="Coverage"> <img src="https://czodecov.io/gh/collerek/async-orm/branch/master/graph/badge.svg" alt="Coverage">
</a> </a>
<a href="https://www.codefactor.io/repository/github/collerek/ormar"> <a href="https://www.codefactor.io/repository/github/collerek/ormar">
<img src="https://www.codefactor.io/repository/github/collerek/ormar/badge" alt="CodeFactor" /> <img src="https://www.codefactor.io/repository/github/collerek/ormar/badge" alt="CodeFactor" />
@ -15,21 +15,21 @@
</a> </a>
</p> </p>
The `async-orm` package is an async ORM for Python, with support for Postgres, The `ormar` package is an async ORM for Python, with support for Postgres,
MySQL, and SQLite. ORM is built with: MySQL, and SQLite. Ormar is built with:
* [`SQLAlchemy core`][sqlalchemy-core] for query building. * [`SQLAlchemy core`][sqlalchemy-core] for query building.
* [`databases`][databases] for cross-database async support. * [`databases`][databases] for cross-database async support.
* [`pydantic`][pydantic] for data validation. * [`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. 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]. 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. 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`. **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 note.pk # 2
``` ```
ORM supports loading and filtering across foreign keys... Ormar supports loading and filtering across foreign keys...
```python ```python
import databases 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. Autoincrement is set by default on int primary keys.
Available Model Fields: Available Model Fields:
* `orm.String(length)` * `String(length)`
* `orm.Text()` * `Text()`
* `orm.Boolean()` * `Boolean()`
* `orm.Integer()` * `Integer()`
* `orm.Float()` * `Float()`
* `orm.Date()` * `Date()`
* `orm.Time()` * `Time()`
* `orm.DateTime()` * `DateTime()`
* `orm.JSON()` * `JSON()`
* `orm.BigInteger()` * `BigInteger()`
* `orm.Decimal(lenght, precision)` * `Decimal(lenght, precision)`
[sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/ [sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
[databases]: https://github.com/encode/databases [databases]: https://github.com/encode/databases