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

This version

3.0.1

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.0.1.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-3.0.1.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

File hashes

Hashes for muffin-rest-3.0.1.tar.gz
Algorithm Hash digest
SHA256 863b44d225c94ad2f58dc11ffac8e9b7b9476e468dd92fc006c66c49d2b5cc60
MD5 01ce1f08738df7d636a7de0bf42578c9
BLAKE2b-256 b56c41603162108f791f6f284b5efc76eb29d403f6d6c224eb7d024fac87eb48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-3.0.1-py3-none-any.whl
  • Upload date:
  • Size: 30.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.6

File hashes

Hashes for muffin_rest-3.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7972cc9203ad78e8e7e94cfebd3e888b4ef23a4d18327ad072b029b835fe866a
MD5 a8cf268c656a46ab9066577fc6f8b71e
BLAKE2b-256 580945b666d34d2d93558731014f087044b272c2bb91ff706f6c1db031b060dd

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