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

Uploaded Source

Built Distribution

muffin_rest-2.7.1-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-2.7.1.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for muffin-rest-2.7.1.tar.gz
Algorithm Hash digest
SHA256 781fc480398752eed27aa0fdc66f090f3733ea58eae91db20634165a5a3e7bad
MD5 014d9d0913f1b33b43c9ecc227bf102d
BLAKE2b-256 57d9f32ea1ee5f7d0f9ccf05f31bf6dde1ff0c41ca9ed31b40669d92b8cc0bfb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-2.7.1-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for muffin_rest-2.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 78519eb5fde0984dfe0b6314bc86a44d4ab3b6d7eae174fd193b55072459f27c
MD5 a611fce421d0e5b155f4c7cc7be3c9f4
BLAKE2b-256 455f72e513a3a041a9aeb6cabcebf733930b60bedfec983bbb21deb639823874

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