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

Uploaded Source

Built Distribution

muffin_rest-4.6.4-py3-none-any.whl (34.2 kB view details)

Uploaded Python 3

File details

Details for the file muffin_rest-4.6.4.tar.gz.

File metadata

  • Download URL: muffin_rest-4.6.4.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/5.15.0-1034-azure

File hashes

Hashes for muffin_rest-4.6.4.tar.gz
Algorithm Hash digest
SHA256 96f3d9e121b8b73c3ba00f445fbb54639b619d4866b8bc6ddc8c946d1e9eff74
MD5 788246ab2128f13dee2da40d52a472cc
BLAKE2b-256 95cf93794de0dce9fc3b6221bca6e285d98ac442f47c22a32c0bd479e03fb4bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.6.4-py3-none-any.whl
  • Upload date:
  • Size: 34.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/5.15.0-1034-azure

File hashes

Hashes for muffin_rest-4.6.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7cde43544630357e87986ea3ffef37bb1fca3de89682e3da0929e700a98c8ea7
MD5 047d93f27bf9f0aa9dd455eb6b803a7a
BLAKE2b-256 0b33e57f5973f847e1d26d9436641a75847d519c51debcc06dd99cc8aefa7b4a

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