the package provides enhanced support for writing REST APIs with Muffin_.
Project description
Muffin-REST – provides enhanced support for writing REST APIs with Muffin.
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;
Requirements
python >= 3.7
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
Create an API:
from muffin_rest import API
api = API()Create endpoints and connect them to the API (example for sqlalchemy):
from muffin_rest.sqlalchemy import SAEndpoint
from project.api import api
@api.route
class MyEndpoint(SAEndpoint):
class Meta:
table = MyTable
database = dbConnect it to your Muffin application:
from project.api import api
api.setup(app, prefix='/api/v1')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
Development of Muffin-REST happens at: https://github.com/klen/muffin-rest
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file muffin_rest-2.5.2-py3-none-any.whl.
File metadata
- Download URL: muffin_rest-2.5.2-py3-none-any.whl
- Upload date:
- Size: 25.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 38a6a72a3513581efe73e00f2b57e0cdb3cba112de7ce053a094601cfbe539bc |
|
| MD5 | a5aaf1e3465b18d2e5dccdb48bd69189 |
|
| BLAKE2b-256 | 2e8b3dea0de14aa94f1c21901af0e81bab257a68df8c8ef3394065804dcf3e69 |
