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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-4.5.1.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.5.1.tar.gz
Algorithm Hash digest
SHA256 636988baf992a7dc049e79691bb26cfcc73435171cd20682a36b939902c6a0da
MD5 d71ffd6eaec6da17cbe4d137ff37ba2c
BLAKE2b-256 b87685a188fd3776bcc5f86f4c2e8a6593cb9410768728eacb22be820362a2dc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.5.1-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.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5ae09fc63939c504ce8c183f2393b8cbb8a8ba49dfeb044c1d75c5ec8bff33e3
MD5 73535ed761fd312b5eba5584887c103d
BLAKE2b-256 d5cdea051cf0c190ebb1d6951b99d5ad3a7d92f1268bbd3426bcfecc757be6d8

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