Skip to main content

The package provides enhanced support for writing REST APIs with Muffin framework

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

Uploaded Source

Built Distribution

muffin_rest-4.4.3-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.4.3.tar.gz
  • Upload date:
  • Size: 31.5 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.4.3.tar.gz
Algorithm Hash digest
SHA256 156c760f34b396873d27b775e6a56b167fc60ebec7f686881b60c3310b32808e
MD5 b411296d9c14d77035f0af768960b8d7
BLAKE2b-256 e285cc434c97df593fe5943f59cbe64fc83f662d388bf49ad0cce40c870984cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.4.3-py3-none-any.whl
  • Upload date:
  • Size: 33.9 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.4.3-py3-none-any.whl
Algorithm Hash digest
SHA256 58c2617e5b9b6ca9942a2dac07fab18a9b2a0c436bf8bd750856009262c4a517
MD5 399512c4cd6679070a13672ce31d7da2
BLAKE2b-256 1d16bd7434159bc232faa411d68ff6d518e29ffc37ac1eed3b8d85be0f26ebd5

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