Skip to main content

The package provides enhanced support for writing REST APIs with Muffin framework

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

Uploaded Source

Built Distribution

muffin_rest-4.7.1-py3-none-any.whl (34.6 kB view details)

Uploaded Python 3

File details

Details for the file muffin_rest-4.7.1.tar.gz.

File metadata

  • Download URL: muffin_rest-4.7.1.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.6 Linux/5.15.0-1034-azure

File hashes

Hashes for muffin_rest-4.7.1.tar.gz
Algorithm Hash digest
SHA256 7fb856c1a0e1cbcb36c5b8c09cf843debaca76b34965bfc232afd59399d6309d
MD5 ab2f682bd7f1b6665ea668a588754717
BLAKE2b-256 c71aa8f6381b5476080495ee6a5535b7e4369bc91d8054b165cce07c9e00fc59

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.7.1-py3-none-any.whl
  • Upload date:
  • Size: 34.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.1 CPython/3.10.6 Linux/5.15.0-1034-azure

File hashes

Hashes for muffin_rest-4.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d9fee7dcb335b4834e61514bebc4e7efcdb869809a1d886c61960278b28615b5
MD5 cf20e146c8ef81fa83efcd80975f8537
BLAKE2b-256 951fbc73bc09fb8bb0c35ff7095157edecebdec2a4922b7a7d5b87843922bef8

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