Skip to main content

the package provides enhanced support for writing REST APIs with Muffin_.

Project description

Muffin-REST – provides enhanced support for writing REST APIs with Muffin.

Tests Status PYPI Version Python Versions

Features

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 = db

Connect 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.

Project details


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 Distribution

muffin-rest-3.4.4.tar.gz (22.6 kB view details)

Uploaded Source

Built Distribution

muffin_rest-3.4.4-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

Details for the file muffin-rest-3.4.4.tar.gz.

File metadata

  • Download URL: muffin-rest-3.4.4.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for muffin-rest-3.4.4.tar.gz
Algorithm Hash digest
SHA256 68f2c45aa5d213e924ae86020dd55a5409f5f083414fc8221697173c99254c76
MD5 7deb04a25207e620c6fa9a45880f1052
BLAKE2b-256 072f9c0f3e067990a383fba037e3cc3990f594002fb07e5b0171e08119642913

See more details on using hashes here.

File details

Details for the file muffin_rest-3.4.4-py3-none-any.whl.

File metadata

  • Download URL: muffin_rest-3.4.4-py3-none-any.whl
  • Upload date:
  • Size: 30.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for muffin_rest-3.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 11a3be646c106402154e116a4e4fe1238e655465983eb5617d875037e37e1060
MD5 3d59fab8596776d473cca122fbb46343
BLAKE2b-256 abf4c945c953ba1f631dcde3cee017768d799b3ed0d8b7a8a3098a8037feb97e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page