update docs and readme

README.md

@@ -220,7 +220,10 @@ async def create():
 
 async def read():
     # Fetch an instance, without loading a foreign key relationship on it.
+    # Django style
     book = await Book.objects.get(title="The Hobbit")
+    # or python style
+    book = await Book.objects.get(Book.title == "The Hobbit")
     book2 = await Book.objects.first()
 
     # first() fetch the instance with lower primary key value
@@ -334,20 +337,30 @@ async def filter_and_sort():
     # get(), all() etc.
     # to use special methods or access related model fields use double
     # underscore like to filter by the name of the author use author__name
+    # Django style
     books = await Book.objects.all(author__name="J.R.R. Tolkien")
+    # python style
+    books = await Book.objects.all(Book.author.name == "J.R.R. Tolkien")
     assert len(books) == 3
 
     # filter can accept special methods also separated with double underscore
     # to issue sql query ` where authors.name like "%tolkien%"` that is not
     # case sensitive (hence small t in Tolkien)
+    # Django style
     books = await Book.objects.filter(author__name__icontains="tolkien").all()
+    # python style
+    books = await Book.objects.filter(Book.author.name.icontains("tolkien")).all()
     assert len(books) == 3
 
     # to sort use order_by() function of queryset
     # to sort decreasing use hyphen before the field name
     # same as with filter you can use double underscores to access related fields
+    # Django style
     books = await Book.objects.filter(author__name__icontains="tolkien").order_by(
         "-year").all()
+    # python style
+    books = await Book.objects.filter(Book.author.name.icontains("tolkien")).order_by(
+        Book.year.desc()).all()
     assert len(books) == 3
     assert books[0].title == "The Silmarillion"
     assert books[2].title == "The Hobbit"
@@ -417,12 +430,24 @@ async def pagination():
 
 
 async def aggregations():
-    # ormar currently supports count:
+    # count:
     assert 2 == await Author.objects.count()
 
-    # and exists
+    # exists:
     assert await Book.objects.filter(title="The Hobbit").exists()
 
+    # max:
+    assert 1990 == await Book.objects.max(columns=["year"])
+
+    # min:
+    assert 1937 == await Book.objects.min(columns=["year"])
+
+    # avg:
+    assert 1964.75 == await Book.objects.avg(columns=["year"])
+
+    # sum:
+    assert 7859 == await Book.objects.sum(columns=["year"])
+
     # to read more about aggregated functions
     # visit: https://collerek.github.io/ormar/queries/aggregations/
 
@@ -448,16 +473,16 @@ metadata.drop_all(engine)
 ### QuerySet methods
 
 *  `create(**kwargs): -> Model`
-*  `get(**kwargs): -> Model`
-*  `get_or_none(**kwargs): -> Optional[Model]`
-*  `get_or_create(**kwargs) -> Model`
-*  `first(): -> Model`
+*  `get(*args, **kwargs): -> Model`
+*  `get_or_none(*args, **kwargs): -> Optional[Model]`
+*  `get_or_create(*args, **kwargs) -> Model`
+*  `first(*args, **kwargs): -> Model`
 *  `update(each: bool = False, **kwargs) -> int`
 *  `update_or_create(**kwargs) -> Model`
 *  `bulk_create(objects: List[Model]) -> None`
 *  `bulk_update(objects: List[Model], columns: List[str] = None) -> None`
-*  `delete(each: bool = False, **kwargs) -> int`
-*  `all(**kwargs) -> List[Optional[Model]]`
+*  `delete(*args, each: bool = False, **kwargs) -> int`
+*  `all(*args, **kwargs) -> List[Optional[Model]]`
 *  `filter(*args, **kwargs) -> QuerySet`
 *  `exclude(*args, **kwargs) -> QuerySet`
 *  `select_related(related: Union[List, str]) -> QuerySet`
@@ -466,6 +491,10 @@ metadata.drop_all(engine)
 *  `offset(offset: int) -> QuerySet`
 *  `count() -> int`
 *  `exists() -> bool`
+*  `max(columns: List[str]) -> Any`
+*  `min(columns: List[str]) -> Any`
+*  `avg(columns: List[str]) -> Any`
+*  `sum(columns: List[str]) -> Any`
 *  `fields(columns: Union[List, str, set, dict]) -> QuerySet`
 *  `exclude_fields(columns: Union[List, str, set, dict]) -> QuerySet`
 *  `order_by(columns:Union[List, str]) -> QuerySet`