Skip to main content

the package provides enhanced support for writing REST APIs with Muffin_.

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

Uploaded Source

Built Distribution

muffin_rest-4.2.4-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.2.4.tar.gz
  • Upload date:
  • Size: 24.6 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.2.4.tar.gz
Algorithm Hash digest
SHA256 8ae9efd9baeb5a08a02a2cee53cf06160b08e7a6a86ae5c9ef6c6c5121882bab
MD5 6713bc00921e94cbec367ac0b77af948
BLAKE2b-256 de9dc3c35b87fbcb20686b0de807b970b4461fb574d4053a9b1a1f031384ea69

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.2.4-py3-none-any.whl
  • Upload date:
  • Size: 31.4 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.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 4d500341ad290a4dc268ff28d8f2960942ffc6638d39753ce35e1f9d054b7676
MD5 8226b7f3e03bd3ce86f16ab173df3fdd
BLAKE2b-256 f1970841d10234b7d2f57342a4d2f99f1d830a0d5108aa8694160e1fe1884f00

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