muffin-rest 11.0.1__py3-none-any.whl → 12.0.1__py3-none-any.whl

muffin_rest/peewee/sorting.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Union, cast
+from typing import TYPE_CHECKING, cast
 
 from peewee import Field
 
@@ -11,6 +11,7 @@ from muffin_rest.sorting import Sort, Sorting
 from .utils import get_model_field_by_name
 
 if TYPE_CHECKING:
+    from . import PWRESTHandler
     from .types import TVCollection
 
 
@@ -34,14 +35,13 @@ class PWSorting(Sorting):
         """Prepare collection for sorting."""
         return collection.order_by()
 
-    def convert(self, obj: Union[str, Field, PWSort], **meta):
+    def convert(self, obj: str | Field | PWSort, **meta):
         """Prepare sorters."""
-        from . import PWRESTHandler
 
         if isinstance(obj, PWSort):
             return obj
 
-        handler = cast(PWRESTHandler, self.handler)
+        handler = cast("PWRESTHandler", self.handler)
 
         if isinstance(obj, Field):
             name, field = obj.name, obj

muffin_rest/peewee/utils.py

@@ -2,14 +2,14 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Optional
+from typing import TYPE_CHECKING
 from warnings import warn
 
 if TYPE_CHECKING:
     from peewee import Field
 
 
-def get_model_field_by_name(handler, name: str, *, stacklevel=5) -> Optional[Field]:
+def get_model_field_by_name(handler, name: str, *, stacklevel=5) -> Field | None:
     """Get model field by name."""
     fields = handler.meta.model._meta.fields
     candidate = fields.get(name)

muffin_rest/sorting.py

@@ -1,15 +1,16 @@
 """Implement sorting."""
+
 from __future__ import annotations
 
 from typing import TYPE_CHECKING, Any, Generator, Iterable, Mapping, Sequence, cast
 
-from .types import TVCollection
 from .utils import Mutate, Mutator
 
 if TYPE_CHECKING:
     from muffin import Request
 
     from .handler import RESTBase
+    from .types import TVCollection
 
 SORT_PARAM = "sort"
 
@@ -60,14 +61,14 @@ class Sorting(Mutator):
 
     def convert(self, obj, **meta) -> Sort:
         """Prepare sorters."""
-        sort = cast(Sort, super(Sorting, self).convert(obj, **meta))
+        sort = cast("Sort", super(Sorting, self).convert(obj, **meta))
         if sort.meta.get("default"):
             self.default.append(sort)
         return sort
 
     def sort_default(self, collection: TVCollection) -> TVCollection:
         """Sort by default."""
-        return cast(TVCollection, sorted(collection))
+        return cast("TVCollection", sorted(collection))
 
     @property
     def openapi(self):

muffin_rest/sqlalchemy/__init__.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, Optional, cast
+from typing import TYPE_CHECKING, Any, cast
 
 import marshmallow as ma
 import sqlalchemy as sa
@@ -18,11 +18,10 @@ if TYPE_CHECKING:
     from muffin import Request
     from muffin_databases import Plugin as Database
 
-    from muffin_rest.types import TVData
 
 from .types import TVResource
 
-ModelConverter._get_field_name = lambda _, prop_or_column: str(prop_or_column.key)  # type: ignore[method-assign]
+ModelConverter._get_field_name = lambda _, prop_or_column: str(prop_or_column.key)  # type: ignore[assignment]
 
 
 class SQLAlchemyAutoSchema(BaseSQLAlchemyAutoSchema):
@@ -101,7 +100,7 @@ class SARESTOptions(RESTOptions):
                     "unknown": self.schema_unknown,
                     "table": self.table,
                     "include_fk": True,
-                    "dump_only": (self.name_id,),
+                    "dump_only": (self.pk,),
                 },
                 **self.schema_meta,
             ),
@@ -125,7 +124,7 @@ class SARESTHandler(RESTHandler[TVResource]):
         *,
         limit: int = 0,
         offset: int = 0,
-    ) -> tuple[sa.sql.Select, Optional[int]]:
+    ) -> tuple[sa.sql.Select, int | None]:
         """Paginate the collection."""
         sqs = self.collection.order_by(None).subquery()
         qs = sa.select(sa.func.count()).select_from(sqs)
@@ -134,7 +133,7 @@ class SARESTHandler(RESTHandler[TVResource]):
             total = await self.meta.database.fetch_val(qs)
         return self.collection.offset(offset).limit(limit), total
 
-    async def get(self, request, *, resource: Optional[TVResource] = None) -> Any:
+    async def get(self, request, *, resource: TVResource | None = None) -> Any:
         """Get resource or collection of resources."""
         if resource:
             return await self.dump(request, resource)
@@ -142,9 +141,9 @@ class SARESTHandler(RESTHandler[TVResource]):
         rows = await self.meta.database.fetch_all(self.collection)
         return await self.dump(request, rows, many=True)
 
-    async def prepare_resource(self, request: Request) -> Optional[TVResource]:
+    async def prepare_resource(self, request: Request) -> TVResource | None:
         """Load a resource."""
-        pk = request["path_params"].get(self.meta.name_id)
+        pk = request["path_params"].get("pk")
         if not pk:
             return None
 
@@ -152,19 +151,19 @@ class SARESTHandler(RESTHandler[TVResource]):
         resource = await self.meta.database.fetch_one(qs)
         if resource is None:
             raise APIError.NOT_FOUND("Resource not found")
-        return cast(TVResource, dict(resource))
+        return cast("TVResource", dict(resource))
 
     def get_schema(
-        self, request: Request, *, resource: Optional[TVResource] = None, **schema_options
+        self, request: Request, *, resource: TVResource | None = None, **schema_options
     ) -> ma.Schema:
         """Initialize marshmallow schema for serialization/deserialization."""
         return super().get_schema(request, instance=resource, **schema_options)
 
-    async def save(self, _: Request, resource: TVData[TVResource], *, update=False):
+    async def save(self, request: Request, resource: TVResource, *, update=False):
         """Save the given resource."""
         meta = self.meta
         insert_query = meta.table.insert()
-        table_pk = cast(sa.Column, meta.table_pk)
+        table_pk = cast("sa.Column", meta.table_pk)
         if update:
             update_query = self.meta.table.update().where(table_pk == resource[table_pk.name])  # type: ignore[call-overload]
             await meta.database.execute(update_query, resource)
@@ -174,14 +173,14 @@ class SARESTHandler(RESTHandler[TVResource]):
 
         return resource
 
-    async def remove(self, request: Request, resource: Optional[TVResource] = None):
+    async def remove(self, request: Request, resource: TVResource | None = None):
         """Remove the given resource."""
-        table_pk = cast(sa.Column, self.meta.table_pk)
+        table_pk = cast("sa.Column", self.meta.table_pk)
         pks = [resource[table_pk.name]] if resource else await request.data()
         if not pks:
             raise APIError.NOT_FOUND()
 
-        delete = self.meta.table.delete().where(table_pk.in_(cast(list[Any], pks)))
+        delete = self.meta.table.delete().where(table_pk.in_(cast("list[Any]", pks)))
         await self.meta.database.execute(delete)
 
     delete = remove

muffin_rest/sqlalchemy/filters.py

@@ -2,7 +2,7 @@
 
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Any, ClassVar, Union, cast
+from typing import TYPE_CHECKING, Any, ClassVar, cast
 
 from sqlalchemy import Column
 
@@ -11,6 +11,7 @@ from muffin_rest.filters import Filter, Filters
 if TYPE_CHECKING:
     from muffin_rest.types import TFilterValue
 
+    from . import SARESTHandler
     from .types import TVCollection
 
 
@@ -49,11 +50,10 @@ class SAFilters(Filters):
 
     MUTATE_CLASS = SAFilter
 
-    def convert(self, obj: Union[str, Column, SAFilter], **meta):
+    def convert(self, obj: str | Column | SAFilter, **meta):
         """Convert params to filters."""
-        from . import SARESTHandler
 
-        handler = cast(SARESTHandler, self.handler)
+        handler = cast("SARESTHandler", self.handler)
 
         if isinstance(obj, SAFilter):
             if obj.field is None:

muffin_rest/sqlalchemy/sorting.py

@@ -1,13 +1,15 @@
 """Support sorting for SQLAlchemy ORM."""
+
 from __future__ import annotations
 
-from typing import TYPE_CHECKING, Union, cast
+from typing import TYPE_CHECKING, cast
 
 from sqlalchemy import Column
 
 from muffin_rest.sorting import Sort, Sorting
 
 if TYPE_CHECKING:
+    from . import SARESTHandler
     from .types import TVCollection
 
 
@@ -15,7 +17,11 @@ class SASort(Sort):
     """Sorter for Peewee."""
 
     async def apply(
-        self, collection: TVCollection, *, desc: bool = False, **_,
+        self,
+        collection: TVCollection,
+        *,
+        desc: bool = False,
+        **_,
     ) -> TVCollection:
         """Sort the collection."""
         field = self.field
@@ -30,21 +36,20 @@ class SASorting(Sorting):
 
     MUTATE_CLASS = SASort
 
-    def convert(self, obj: Union[str, Column, SASort], **meta):
+    def convert(self, obj: str | Column | SASort, **meta):
         """Prepare sorters."""
-        from . import SARESTHandler
 
         if isinstance(obj, SASort):
             return obj
 
-        handler = cast(SARESTHandler, self.handler)
+        handler = cast("SARESTHandler", self.handler)
 
         if isinstance(obj, Column):
             name, field = obj.name, obj
 
         else:
             name = obj
-            field = meta.get("field", handler.meta.table.c.get(name))
+            field = meta.get("field", handler.meta.table.c.get(name))  # type: ignore[assignment]
 
         if field is not None:
             sort = self.MUTATE_CLASS(name, field=field, **meta)

muffin_rest/types.py

@@ -4,7 +4,6 @@ from typing import (
     Awaitable,
     Callable,
     TypeVar,
-    Union,
 )
 
 if TYPE_CHECKING:
@@ -14,7 +13,6 @@ from muffin import Request
 
 TVCollection = TypeVar("TVCollection", bound=Any)
 TVResource = TypeVar("TVResource", bound=Any)
-TVData = Union[TVResource, list[TVResource]]
 TAuth = Callable[[Request], Awaitable]
 TVAuth = TypeVar("TVAuth", bound=TAuth)
 TVHandler = TypeVar("TVHandler", bound=type["RESTBase"])

muffin_rest-12.0.1.dist-info/METADATA

@@ -0,0 +1,176 @@
+Metadata-Version: 2.3
+Name: muffin-rest
+Version: 12.0.1
+Summary: The package provides enhanced support for writing REST APIs with Muffin framework
+License: MIT
+Keywords: rest,api,muffin,asgi,asyncio,trio
+Author: Kirill Klenov
+Author-email: horneds@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Trio
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Provides-Extra: peewee
+Provides-Extra: sqlalchemy
+Provides-Extra: yaml
+Requires-Dist: apispec (>=6,<7)
+Requires-Dist: marshmallow (>=3,<4)
+Requires-Dist: marshmallow-peewee ; extra == "peewee"
+Requires-Dist: marshmallow-sqlalchemy ; extra == "sqlalchemy"
+Requires-Dist: muffin
+Requires-Dist: muffin-databases ; extra == "sqlalchemy"
+Requires-Dist: muffin-peewee-aio ; extra == "peewee"
+Requires-Dist: pyyaml ; extra == "yaml"
+Requires-Dist: sqlalchemy ; extra == "sqlalchemy"
+Project-URL: Homepage, https://github.com/klen/muffin-rest
+Project-URL: Repository, https://github.com/klen/muffin-rest
+Description-Content-Type: text/markdown
+
+# Muffin‑REST
+
+**Muffin‑REST** simplifies building RESTful APIs with [Muffin](https://github.com/klen/muffin) by offering:
+
+- Declarative `API` class with resource registration
+- Built-in filtering, sorting, pagination, and search
+- Support for:
+  - [Peewee ORM](http://docs.peewee-orm.com/en/latest/) via `PeeweeEndpoint`
+  - [SQLAlchemy Core](https://docs.sqlalchemy.org/en/14/core/) via `SAEndpoint`
+  - [MongoDB](https://www.mongodb.com/) via `MongoEndpoint`
+- [Swagger/OpenAPI](https://swagger.io/) autodocumentation
+- Works with asyncio, Trio, and Curio
+
+[![Tests Status](https://github.com/klen/muffin-rest/workflows/tests/badge.svg)](https://github.com/klen/muffin-rest/actions)
+[![PyPI Version](https://img.shields.io/pypi/v/muffin-rest)](https://pypi.org/project/muffin-rest/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/muffin-rest)](https://pypi.org/project/muffin-rest/)
+
+## Requirements
+
+- Python >= 3.10
+- Trio requires Peewee backend
+
+## Installation
+
+Install core package:
+
+```bash
+pip install muffin-rest
+```
+
+Add optional backend support:
+
+- SQLAlchemy Core: `pip install muffin-rest[sqlalchemy]`
+- Peewee ORM: `pip install muffin-rest[peewee]`
+- YAML support for Swagger: `pip install muffin-rest[yaml]`
+
+## Quickstart (Peewee example)
+
+```python
+from muffin import Application
+from muffin_rest import API
+from muffin_rest.peewee import PeeweeEndpoint
+from models import User  # your Peewee model
+
+app = Application("myapp")
+api = API(title="User Service", version="1.0")
+
+@api.route
+class UsersEndpoint(PeeweeEndpoint):
+    class Meta:
+        model = User
+        lookup_field = "id"
+        filters = ["name", "email"]
+        ordering = ["-created_at"]
+
+api.setup(app, prefix="/api", swagger=True)
+```
+
+Endpoints available:
+
+- `GET    /api/users/` — list with pagination, search, filtering
+- `POST   /api/users/` — create
+- `GET    /api/users/{id}/` — retrieve
+- `PUT    /api/users/{id}/` — replace
+- `PATCH  /api/users/{id}/` — update
+- `DELETE /api/users/{id}/` — remove
+- Docs: `/api/docs/`, OpenAPI spec: `/api/openapi.json`
+
+## Usage with SQLAlchemy
+
+```python
+from muffin_rest import API
+from muffin_rest.sqlalchemy import SAEndpoint
+from models import my_table, db_engine
+
+api = API()
+@api.route
+class MySAEndpoint(SAEndpoint):
+    class Meta:
+        table = my_table
+        database = db_engine
+
+api.setup(app)
+```
+
+## Usage with MongoDB
+
+```python
+from muffin_rest import API
+from muffin_rest.mongo import MongoEndpoint
+from models import mongo_collection
+
+api = API()
+@api.route
+class MyMongoEndpoint(MongoEndpoint):
+    class Meta:
+        collection = mongo_collection
+
+api.setup(app)
+```
+
+## Advanced Configuration
+
+Customize Swagger and routes via constructor:
+
+```python
+api = API(
+    title="Service API",
+    version="2.1",
+    swagger_ui=True,
+    openapi_path="/api/openapi.json",
+    docs_path="/api/docs/"
+)
+```
+
+## Contributing & Examples
+
+- See `examples/` for live application demos
+- Tests in `tests/` focus on filtering, pagination, status codes
+- Check `CHANGELOG.md` for latest changes
+
+## Bug Tracker
+
+Report bugs or request features:
+https://github.com/klen/muffin-rest/issues
+
+## Contributing
+
+Repo: https://github.com/klen/muffin-rest
+Pull requests, example additions, docs improvements welcome!
+
+## Contributors
+
+- [klen](https://github.com/klen) (Kirill Klenov)
+
+## License
+
+Licensed under the [MIT license](http://opensource.org/licenses/MIT).
+

muffin_rest-12.0.1.dist-info/RECORD

@@ -0,0 +1,39 @@
+muffin_rest/__init__.py,sha256=JnwsHQNDmJpOqETeIjjPheG891T5WQ0JBaiEV72Wcmg,1242
+muffin_rest/api.py,sha256=bdbXMPiZi5yXf7_u3XB_gaGDHZKzDPqnnFnrwHoO1Rs,3799
+muffin_rest/errors.py,sha256=Todg7CrCE1ufOsyyARI2Bv-RqNPH4Rl1p-Tkpq7VYrA,1151
+muffin_rest/filters.py,sha256=nWlwDLuId-mmP3tgZjp1joYCVx0k9ekV42fPIMMKphM,5920
+muffin_rest/handler.py,sha256=qpG4ioIagdYqGFOrlT7pBx-0czgS2ZI3AvqKXz9EzcA,10762
+muffin_rest/limits.py,sha256=Fnlu4Wj3B-BzpahLK-rDbd1GEd7CEQ3zxyOD0vee7GE,2007
+muffin_rest/marshmallow.py,sha256=-MyMKiaMTfiWw4y-4adpfoQd05HV1vEKqSXJh8eD3xg,548
+muffin_rest/mongo/__init__.py,sha256=oPfTF_cG4LD1TDm-RoyxhSS1pVDXConCKQf9rz2QlZM,4644
+muffin_rest/mongo/filters.py,sha256=yIxIDVqMn6SoDgVhCqiTxYetw0hoaf_3jIvX2Vnizok,964
+muffin_rest/mongo/schema.py,sha256=y4OEPQnlV_COTIIQ3cKmpqDpD2r18eAWn0rijQldWm0,1205
+muffin_rest/mongo/sorting.py,sha256=iJBnaFwE7g_JMwpGpQkoqSqbQK9XULx1K3skiRRgLgY,870
+muffin_rest/mongo/types.py,sha256=jaODScgwwYbzHis3DY4bPzU1ahiMJMSwquH5_Thi-Gg,200
+muffin_rest/mongo/utils.py,sha256=jirD2Hxk28Wadpq_F08t40dYBygq6W1_0cD3261kCgo,3949
+muffin_rest/openapi.py,sha256=VrkyZr_T0ykAQsvkFQ_yarZ-Zs55AmAGf4aNLsUdjGA,8715
+muffin_rest/options.py,sha256=VO1d7nzKSxPw9QidNiyNSfMDX46ZCK0a-iFbJyzNXEE,2227
+muffin_rest/peewee/__init__.py,sha256=94DSj_ftT6fbPksHlBv40AH2HWaiZommUFOMN2jd9a4,129
+muffin_rest/peewee/filters.py,sha256=8CqleDEn4vVQvBLXEaGOjM2N7sY117EQ4GThPhlDPE8,2494
+muffin_rest/peewee/handler.py,sha256=qu-ma1zhMGvzVbqpBEdSkify2UbffT58SLjWUoT_1ws,5418
+muffin_rest/peewee/openapi.py,sha256=ktgsmB9wFNvcTbTaDkMQFLdQxk3osDFW5LkUSFVjcQo,1093
+muffin_rest/peewee/options.py,sha256=TimJtErC9e8B7BRiEkHiBZd71_bZbYr-FE2PIlQvfH0,1455
+muffin_rest/peewee/schemas.py,sha256=hQG2UKR7gEMsz0n75L3tvkVzUX3baXMJ94emgIc1Scw,439
+muffin_rest/peewee/sorting.py,sha256=aBtQkj3iSo6XjBZ8evJuprIkhv1nHFi7wFb0an6Dn34,1963
+muffin_rest/peewee/types.py,sha256=cgCXhpGHkImKwudA1lulZHz5oJswHH168AiW5MhZRCM,155
+muffin_rest/peewee/utils.py,sha256=8wTSKmjeD3qtF5NFHX1wkBn4jiXFvCzNEK9WW7r_JmI,693
+muffin_rest/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+muffin_rest/redoc.html,sha256=GtuHIMvTuSi8Ro6bgI-G8VB94AljMyfjcZseqtBmGCY,559
+muffin_rest/schemas.py,sha256=BW3dF82C6Q6STs4tZjej1x8Ii1rI3EZUJZR4mNNKmu4,875
+muffin_rest/sorting.py,sha256=nu4SGW5uxLETJIywE-1UTCCya9QAvYWcq-P8dPWQixI,2822
+muffin_rest/sqlalchemy/__init__.py,sha256=pZt_3t8I4uU8WssrksdEn8LXS0ytKT4NHioTpFqKDiw,6312
+muffin_rest/sqlalchemy/filters.py,sha256=Lf1nPOQjDT7Nv1HAwowfWYTHWCrIMpw-4aWwoaNVlVU,2475
+muffin_rest/sqlalchemy/sorting.py,sha256=qmzP18ongriCGs2Ok_OllEybqWgppU-Kakg0JL1DM_M,1690
+muffin_rest/sqlalchemy/types.py,sha256=Exm-zAQCtPAwXvYcCTtPRqSa-wTEWRcH_v2YSsJkB6s,198
+muffin_rest/swagger.html,sha256=2uGLu_KpkYf925KnDKHBJmV9pm6OHn5C3BWScESsUS8,1736
+muffin_rest/types.py,sha256=5NY9gPTIptv6U2Qab2xMXlS_jZuTuR0bquFFwWRURcA,510
+muffin_rest/utils.py,sha256=c08E4HJ4SLYC-91GKPEbsyKTZ4sZbTN4qDqJbNg_HTE,2076
+muffin_rest-12.0.1.dist-info/LICENSE,sha256=xHPkOZhjyKBMOwXpWn9IB_BVLjrrMxv2M9slKkHj2hM,1082
+muffin_rest-12.0.1.dist-info/METADATA,sha256=dXgMCxDzBPevm7z9iHGm7okdhQCIRX-R8RGCHUwdjWo,4912
+muffin_rest-12.0.1.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+muffin_rest-12.0.1.dist-info/RECORD,,

muffin_rest-11.0.1.dist-info/METADATA

@@ -1,182 +0,0 @@
-Metadata-Version: 2.3
-Name: muffin-rest
-Version: 11.0.1
-Summary: The package provides enhanced support for writing REST APIs with Muffin framework
-License: MIT
-Keywords: rest,api,muffin,asgi,asyncio,trio
-Author: Kirill Klenov
-Author-email: horneds@gmail.com
-Requires-Python: >=3.9,<4.0
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Trio
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Internet :: WWW/HTTP
-Provides-Extra: peewee
-Provides-Extra: sqlalchemy
-Provides-Extra: yaml
-Requires-Dist: apispec (>=6,<7)
-Requires-Dist: marshmallow (>=3,<4)
-Requires-Dist: marshmallow-peewee ; extra == "peewee"
-Requires-Dist: marshmallow-sqlalchemy ; extra == "sqlalchemy"
-Requires-Dist: muffin (>=0,<1)
-Requires-Dist: muffin-databases ; extra == "sqlalchemy"
-Requires-Dist: muffin-peewee-aio ; extra == "peewee"
-Requires-Dist: pyyaml ; extra == "yaml"
-Requires-Dist: sqlalchemy ; extra == "sqlalchemy"
-Project-URL: Homepage, https://github.com/klen/muffin-rest
-Project-URL: Repository, https://github.com/klen/muffin-rest
-Description-Content-Type: text/x-rst
-
-Muffin-REST
-###########
-
-.. _description:
-
-**Muffin-REST** -- provides enhanced support for writing REST APIs with Muffin_.
-
-
-.. _badges:
-
-.. image:: https://github.com/klen/muffin-rest/workflows/tests/badge.svg
-    :target: https://github.com/klen/muffin-rest/actions
-    :alt: Tests Status
-
-.. image:: https://img.shields.io/pypi/v/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: PYPI Version
-
-.. image:: https://img.shields.io/pypi/pyversions/muffin-rest
-    :target: https://pypi.org/project/muffin-rest/
-    :alt: Python Versions
-
-----------
-
-.. _features:
-
-Features
---------
-
-- API class to simplify the creation of REST APIs;
-- Automatic filtering and sorting for resources;
-- Support for `Peewee ORM`_, Mongo_, `SQLAlchemy Core`_;
-- Auto documentation with Swagger_;
-
-.. _contents:
-
-.. contents::
-
-.. _requirements:
-
-Requirements
-=============
-
-- python >= 3.9
-
-.. note:: Trio is only supported with Peewee ORM
-
-.. _installation:
-
-Installation
-=============
-
-**Muffin-REST** should be installed using pip: ::
-
-    pip install muffin-rest
-
-With `SQLAlchemy Core`_ support: ::
-
-    pip install muffin-rest[sqlalchemy]
-
-With `Peewee ORM`_ support: ::
-
-    pip install muffin-rest[peewee]
-
-With YAML support for autodocumentation: ::
-
-    pip install muffin-rest[yaml]
-
-.. _usage:
-
-Usage
-=====
-
-Create an API:
-
-.. code-block:: python
-
-   from muffin_rest import API
-
-   api = API()
-
-Create endpoints and connect them to the API (example for sqlalchemy):
-
-.. code-block:: python
-
-   from muffin_rest.sqlalchemy import SAEndpoint
-   from project.api import api
-
-   @api.route
-   class MyEndpoint(SAEndpoint):
-
-        class Meta:
-            table = MyTable
-            database = db
-
-Connect it to your Muffin_ application:
-
-.. code-block:: python
-
-   from project.api import api
-
-   api.setup(app, prefix='/api/v1')
-
-
-.. _bugtracker:
-
-Bug tracker
-===========
-
-If you have any suggestions, bug reports or
-annoyances please report them to the issue tracker
-at https://github.com/klen/muffin-rest/issues
-
-.. _contributing:
-
-Contributing
-============
-
-Development of Muffin-REST happens at: https://github.com/klen/muffin-rest
-
-
-Contributors
-=============
-
-* klen_ (Kirill Klenov)
-
-.. _license:
-
-License
-========
-
-Licensed under a `MIT license`_.
-
-.. _links:
-
-.. _klen: https://github.com/klen
-.. _Muffin: https://github.com/klen/muffin
-.. _Swagger: https://swagger.io/tools/swagger-ui/
-.. _Mongo: https://www.mongodb.com/
-.. _Peewee ORM: http://docs.peewee-orm.com/en/latest/
-.. _SqlAlchemy Core: https://docs.sqlalchemy.org/en/14/core/
-
-.. _MIT license: http://opensource.org/licenses/MIT
-