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

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

Uploaded Source

Built Distribution

muffin_rest-3.0.0-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for muffin-rest-3.0.0.tar.gz
Algorithm Hash digest
SHA256 9627d5a267f2309326101c77ef38f501e52e994fdcb05c1780ba16b088b7f22c
MD5 a7bb0adf77019003c5473c9c3337b1f6
BLAKE2b-256 fa5ce9513e863f3eaf34c4b6f411a8006aa714342478bb4af76af29421a205d3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 36291aa59716d8334cfa94fb63a6a4b45bf0cc4b9d4cb190e3fd854ec0d2399e
MD5 3e3aa9c3d8faca9ce191cf8e4f613c4c
BLAKE2b-256 048578914122ebb30becf55a68cf75ed6881ec97251cd4ae18a39fc6385e4c42

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