Version 0.2.0 (#64)

Co-authored-by: Amin Alaee <[email protected]>

Author: lovelydinosaur

.github/workflows/test-suite.yml

@@ -57,5 +57,9 @@ jobs:
         env:
           TEST_DATABASE_URL: "mysql://username:password@localhost:3306/testsuite"
         run: "scripts/test"
+      - name: "Run tests with SQLite"
+        env:
+          TEST_DATABASE_URL: "sqlite:///testsuite"
+        run: "scripts/test"
       - name: "Enforce coverage"
         run: "scripts/coverage"

README.md

@@ -41,7 +41,6 @@ $ pip install orm[sqlite]
 ```
 
 Driver support is provided using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
-Note that if you are using any synchronous SQLAlchemy functions such as `engine.create_all()` or [alembic][alembic] migrations then you still have to install a synchronous DB driver: [psycopg2][psycopg2] for PostgreSQL and [pymysql][pymysql] for MySQL.
 
 ---
 
@@ -52,23 +51,22 @@ Note that if you are using any synchronous SQLAlchemy functions such as `engine.
 ```python
 import databases
 import orm
-import sqlalchemy
 
 database = databases.Database("sqlite:///db.sqlite")
-metadata = sqlalchemy.MetaData()
+models = orm.ModelRegistry(database=database)
 
 
 class Note(orm.Model):
-    __tablename__ = "notes"
-    __database__ = database
-    __metadata__ = metadata
-    id = orm.Integer(primary_key=True)
-    text = orm.String(max_length=100)
-    completed = orm.Boolean(default=False)
+    tablename = "notes"
+    registry = models
+    fields = {
+        "id": orm.Integer(primary_key=True),
+        "text": orm.String(max_length=100),
+        "completed": orm.Boolean(default=False),
+    }
 
-# Create the database and tables
-engine = sqlalchemy.create_engine(str(database.url))
-metadata.create_all(engine)
+# Create the tables
+models.create_all()
 
 await Note.objects.create(text="Buy the groceries.", completed=False)
 
@@ -78,9 +76,6 @@ print(note)
 ```
 
 [sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
-[alembic]: https://alembic.sqlalchemy.org/en/latest/
-[psycopg2]: https://www.psycopg.org/
-[pymysql]: https://github.com/PyMySQL/PyMySQL
 [asyncpg]: https://github.com/MagicStack/asyncpg
 [aiomysql]: https://github.com/aio-libs/aiomysql
 [aiosqlite]: https://github.com/jreese/aiosqlite

docs/declaring_models.md

@@ -1,42 +1,39 @@
 ## Declaring models
 
 You can define models by inheriting from `orm.Model` and
-defining model fields as attributes in the class.
+defining model fields in the `fields` attribute.
 For each defined model you need to set two special variables:
 
-* `__database__` for database connection.
-* `__metadata__` for `SQLAlchemy` functions and migrations.
+* `registry` an instance of `orm.ModelRegistry`
+* `fields` a `dict` of `orm` fields
 
-You can also specify the table name in database by setting `__tablename__` attribute.
+You can also specify the table name in database by setting `tablename` attribute.
 
 ```python
 import databases
 import orm
-import sqlalchemy
 
 database = databases.Database("sqlite:///db.sqlite")
-metadata = sqlalchemy.MetaData()
+models = orm.ModelRegistry(database=database)
 
 
 class Note(orm.Model):
-    __tablename__ = "notes"
-    __database__ = database
-    __metadata__ = metadata
-
-    id = orm.Integer(primary_key=True)
-    text = orm.String(max_length=100)
-    completed = orm.Boolean(default=False)
+    tablename = "notes"
+    registry = models
+    fields = {
+        "id": orm.Integer(primary_key=True),
+        "text": orm.String(max_length=100),
+        "completed": orm.Boolean(default=False),
+    }
 ```
 
 ORM can create or drop database and tables from models using SQLAlchemy.
-For using these functions or `Alembic` migrations, you still have to
-install a synchronous DB driver: [psycopg2][psycopg2] for PostgreSQL and [pymysql][pymysql] for MySQL.
-
-Afer installing a synchronous DB driver, you can create tables for the models using:
+You can use the following methods:
 
 ```python
-engine = sqlalchemy.create_engine(str(database.url))
-metadata.create_all(engine)
+models.create_all()
+
+models.drop_all()
 ```
 
 ## Data types
@@ -72,6 +69,4 @@ See `TypeSystem` for [type-specific validation keyword arguments][typesystem-fie
 * `orm.UUID()`
 * `orm.JSON()`
 
-[psycopg2]: https://www.psycopg.org/
-[pymysql]: https://github.com/PyMySQL/PyMySQL
 [typesystem-fields]: https://www.encode.io/typesystem/fields/

docs/index.md

@@ -41,7 +41,6 @@ $ pip install orm[sqlite]
 ```
 
 Driver support is provided using one of [asyncpg][asyncpg], [aiomysql][aiomysql], or [aiosqlite][aiosqlite].
-Note that if you are using any synchronous SQLAlchemy functions such as `engine.create_all()` or [alembic][alembic] migrations then you still have to install a synchronous DB driver: [psycopg2][psycopg2] for PostgreSQL and [pymysql][pymysql] for MySQL.
 
 ---
 
@@ -52,23 +51,22 @@ Note that if you are using any synchronous SQLAlchemy functions such as `engine.
 ```python
 import databases
 import orm
-import sqlalchemy
 
 database = databases.Database("sqlite:///db.sqlite")
-metadata = sqlalchemy.MetaData()
+models = orm.ModelRegistry(database=database)
 
 
 class Note(orm.Model):
-    __tablename__ = "notes"
-    __database__ = database
-    __metadata__ = metadata
-    id = orm.Integer(primary_key=True)
-    text = orm.String(max_length=100)
-    completed = orm.Boolean(default=False)
+    tablename = "notes"
+    registry = models
+    fields = {
+        "id": orm.Integer(primary_key=True),
+        "text": orm.String(max_length=100),
+        "completed": orm.Boolean(default=False),
+    }
 
 # Create the database and tables
-engine = sqlalchemy.create_engine(str(database.url))
-metadata.create_all(engine)
+models.create_all()
 
 await Note.objects.create(text="Buy the groceries.", completed=False)
 
@@ -78,9 +76,6 @@ print(note)
 ```
 
 [sqlalchemy-core]: https://docs.sqlalchemy.org/en/latest/core/
-[alembic]: https://alembic.sqlalchemy.org/en/latest/
-[psycopg2]: https://www.psycopg.org/
-[pymysql]: https://github.com/PyMySQL/PyMySQL
 [asyncpg]: https://github.com/MagicStack/asyncpg
 [aiomysql]: https://github.com/aio-libs/aiomysql
 [aiosqlite]: https://github.com/jreese/aiosqlite

docs/making_queries.md

@@ -7,20 +7,19 @@ Let's say you have the following model defined:
 ```python
 import databases
 import orm
-import sqlalchemy
 
 database = databases.Database("sqlite:///db.sqlite")
-metadata = sqlalchemy.MetaData()
+models = orm.ModelRegistry(database=database)
 
 
 class Note(orm.Model):
-    __tablename__ = "notes"
-    __database__ = database
-    __metadata__ = metadata
-
-    id = orm.Integer(primary_key=True)
-    text = orm.String(max_length=100)
-    completed = orm.Boolean(default=False)
+    tablename = "notes"
+    registry = models
+    fields = {
+        "id": orm.Integer(primary_key=True),
+        "text": orm.String(max_length=100),
+        "completed": orm.Boolean(default=False),
+    }
 ```
 
 You can use the following queryset methods:

docs/relationships.md

@@ -7,30 +7,29 @@ Let's say you have the following models defined:
 ```python
 import databases
 import orm
-import sqlalchemy
 
 database = databases.Database("sqlite:///db.sqlite")
-metadata = sqlalchemy.MetaData()
+models = orm.ModelRegistry(database=database)
 
 
 class Album(orm.Model):
-    __tablename__ = "album"
-    __metadata__ = metadata
-    __database__ = database
-
-    id = orm.Integer(primary_key=True)
-    name = orm.String(max_length=100)
+    tablename = "albums"
+    registry = models
+    fields = {
+        "id": orm.Integer(primary_key=True),
+        "name": orm.String(max_length=100),
+    }
 
 
 class Track(orm.Model):
-    __tablename__ = "track"
-    __metadata__ = metadata
-    __database__ = database
-
-    id = orm.Integer(primary_key=True)
-    album = orm.ForeignKey(Album)
-    title = orm.String(max_length=100)
-    position = orm.Integer()
+    tablename = "tracks"
+    registry = models
+    fields = {
+        "id": orm.Integer(primary_key=True),
+        "album": orm.ForeignKey(Album),
+        "title": orm.String(max_length=100),
+        "position": orm.Integer(),
+    }
 ```
 
 You can create some `Album` and `Track` instances:

orm/__init__.py

@@ -15,9 +15,9 @@
     Text,
     Time,
 )
-from orm.models import Model
+from orm.models import Model, ModelRegistry
 
-__version__ = "0.1.9"
+__version__ = "0.2.0"
 __all__ = [
     "NoMatch",
     "MultipleMatches",
@@ -36,4 +36,5 @@
     "UUID",
     "ForeignKey",
     "Model",
+    "ModelRegistry",
 ]