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

Uploaded Source

Built Distribution

muffin_rest-4.2.5-py3-none-any.whl (32.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.2.5.tar.gz
  • Upload date:
  • Size: 24.8 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.5.tar.gz
Algorithm Hash digest
SHA256 77ddc814ec5dc47b0af16dab4e932a86addaf6abb8e9f1bd48d3ccd2c3188008
MD5 ef71bb7a68df8324410104979b03f921
BLAKE2b-256 e32acbc0382f90a7e9c15de896b806220dcc81e6d91a31a5fda3bb983cdba033

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.2.5-py3-none-any.whl
  • Upload date:
  • Size: 32.5 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d5bfb9abf628154ba10bc669ff4a3962a1b8dd033c7168f887e6c44d3f3a7998
MD5 183c5860268c2360e97e425ded1213f4
BLAKE2b-256 f6b53d2e5217d1588b68c689eaa3523a7695d1d5a9cd7fe0bbcd57988a2aaa6d

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