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

Uploaded Source

Built Distribution

muffin_rest-7.1.0-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-7.1.0.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-1042-azure

File hashes

Hashes for muffin_rest-7.1.0.tar.gz
Algorithm Hash digest
SHA256 5719dbd3c64f0de05f8a9dbb2a0702e50e6e5dba2c850837e0d9bf0c2728ba1e
MD5 5777bb6e5d85ea68693aa3b1a4f91ed2
BLAKE2b-256 bd44cb0bb1893fc49b6640d7d3e1e15ca7ba0e3dcc78ec2f7cba6bfad5215267

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-7.1.0-py3-none-any.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-1042-azure

File hashes

Hashes for muffin_rest-7.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d8296a1438b1291de2f7c217853500dbea56b03e340d1f387660ff6c79bd6e0e
MD5 bcacc86f25111bea979a5a700835c740
BLAKE2b-256 0283d1ed805eda0ae346dad9a87e059f73c51096fdbfe74ff5d70e96d6229caa

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