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

This version

3.1.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-3.1.1.tar.gz (22.8 kB view details)

Uploaded Source

Built Distribution

muffin_rest-3.1.1-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-3.1.1.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for muffin-rest-3.1.1.tar.gz
Algorithm Hash digest
SHA256 7eb1382c220acc1db3c755c6713ee4971ca3f91e472ed5fab4519c9ad1f93b3a
MD5 17868e61a7d7efb72b54907294808451
BLAKE2b-256 bfcf2ffd88be5ed4b703b40457d74d5b3c88a81bbb8e28c534d5331dd4f790ce

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-3.1.1-py3-none-any.whl
  • Upload date:
  • Size: 30.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for muffin_rest-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 918be5746f384e97232b1da72dd1fc1daf3f2637e7e52b307e5b912fa4a6b450
MD5 43bcc9a34dd3cec2131671c58e947c56
BLAKE2b-256 d608ab4115f609a823b61eb65abf96ef8b5387199db52d531bbd1cc7088330b8

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