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

5.2.0

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

Uploaded Source

Built Distribution

muffin_rest-5.2.0-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-5.2.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.6 Linux/5.15.0-1041-azure

File hashes

Hashes for muffin_rest-5.2.0.tar.gz
Algorithm Hash digest
SHA256 efd46e789f86897187e17c78a7bf21b46832151bbfdb61393a97c4b82b971f6f
MD5 7e186a9dbb294fcb5cf0631fd46fb86d
BLAKE2b-256 c91f7831202640165bf381105e16607839de931d4622c134ae86743252e5fbfc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-5.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac8ac89cfc90a8e7c1dca18301a899b56fbe4fbe5450f0cb48121fa86d6e20f3
MD5 4f50509341ce37368b1853b40660fe96
BLAKE2b-256 ea822b4f0c8e5bcef57e17c783e931fd1008b58b3bc67beda23f15593d263c45

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