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.4.1

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.4.1.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.1.tar.gz
Algorithm Hash digest
SHA256 fa398091ab1a32e086b0fabd2d2db85499442bb0fcef0948a333fafee586af82
MD5 275983489a8e6958891ba231d14fb4ea
BLAKE2b-256 d6557ae0644df5a0a94d8e7166e68f968756668ca926925484dd698cba115d70

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.4.1-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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e833562bb44ca244542a2c761352ef5c07273ce188397e7cd0f245ed97a625f5
MD5 62dde4930258dcbfd248c83dce988323
BLAKE2b-256 507bc6dd04c583a66987df3cdcd60d65e0c7851722efa0676ca0bbd37aa368a3

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