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

This version

4.8.7

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

Uploaded Source

Built Distribution

muffin_rest-4.8.7-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-4.8.7.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.15.0-1036-azure

File hashes

Hashes for muffin_rest-4.8.7.tar.gz
Algorithm Hash digest
SHA256 0276419d57517057aaa17bcd101384b686ed2c5542c92300f1f9cb83a9230e70
MD5 abe7e1bde7750d89c2ab1719bf8d5ab9
BLAKE2b-256 0bbaa11edce70d7f190bf788404240581a20263d5c31ed8cbe150e34ea48b7e0

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-4.8.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e4ee6b85f891d465057d31698025886ee9fa12f31758c9afaa4ad02a03721846
MD5 9efacd16d2586ae773d574c4edbbb7af
BLAKE2b-256 ad8d8dca8276fb954a366ba97e21ec96e169563fbb0ad23500e213662735944d

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