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

Uploaded Source

Built Distribution

muffin_rest-4.4.2-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.4.2.tar.gz
  • Upload date:
  • Size: 31.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for muffin-rest-4.4.2.tar.gz
Algorithm Hash digest
SHA256 176ddc4c4030151497ead3d5ef0725da670ea06096e6374dfab550cb4fee1def
MD5 caf64265bf20e2ce073204d324de1b65
BLAKE2b-256 89f6614a10bef1e4c99fd5a0ef954a6a45c41fff511bf81e83cd1aeefe89e0de

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.4.2-py3-none-any.whl
  • Upload date:
  • Size: 33.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for muffin_rest-4.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7b9e0e1856d53b012c5d6d96cccc899a8cf34a154932ff017aa4b29157752f5f
MD5 c5e96c9fe346263ca3ae9a6f6c547408
BLAKE2b-256 97f7937f4d148bf0f75a48a942bbfe0b404506436d8be99674ad4250f0352bcf

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