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

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

Uploaded Source

Built Distribution

muffin_rest-11.0.1-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-11.0.1.tar.gz
  • Upload date:
  • Size: 24.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1015-azure

File hashes

Hashes for muffin_rest-11.0.1.tar.gz
Algorithm Hash digest
SHA256 6a670af7db6e4ce443154d9392b6bd28af79c35823375e7da87418ef2c7d4e80
MD5 1dc5f0539e9546f24458254d5aad6b70
BLAKE2b-256 a5948aee684417bbc4fef594f6e9b78484f9e8baedd5e87d3af3ca741f949bd0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-11.0.1-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.3 Linux/6.11.0-1015-azure

File hashes

Hashes for muffin_rest-11.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 80d7b0c2cd3bf3e2d3cc2d0654c841ed8ce286fdf51a21f8dcba02997838ec4c
MD5 bc69d769136a0b21eebd4e5b463f134a
BLAKE2b-256 20bfc74fe0c1df7fb2b3661f06f18147afaf8f69683c04ef52f3fa82478705a2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page