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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-9.2.0.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for muffin_rest-9.2.0.tar.gz
Algorithm Hash digest
SHA256 d298e552415b54f354f582fbdc3b31ae8805cd19f76c58a002f4165c12ff2b03
MD5 c425354935338c3ef7efc8683b321686
BLAKE2b-256 08be51340223af0c736a6b929c21725cc68657c58519256d158a3e6e0408d8be

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-9.2.0-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for muffin_rest-9.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a4b20dfe1336c8b20be715e1873fc97dfc3ecb46dda79e05b9c82743fdb30182
MD5 915378d0b8c45aeac9653b860797ed5a
BLAKE2b-256 529519f5f23cd6ef2dd2857e1d2b10aea37bae43d89cbdc413297349880fc6cc

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