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

Uploaded Source

Built Distribution

muffin_rest-9.4.0-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-9.4.0.tar.gz
  • Upload date:
  • Size: 25.5 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.4.0.tar.gz
Algorithm Hash digest
SHA256 5643fa52ba75cfeb104383fc1d501514d05791a730198ca3fe28a2ddb2c2ab28
MD5 8d8afea06f186a15d2288278307dae13
BLAKE2b-256 540ccd69faaf11c8548e6719729873220bb86f69b1a005325e0b5ebb54946e38

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-9.4.0-py3-none-any.whl
  • Upload date:
  • Size: 36.5 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c73fb92660c8f58e57bb46f5ee4f47e73067a29bc702de4c92ac8d1fba513079
MD5 d913e5913e2ca42946bf69f1750a445d
BLAKE2b-256 0faea1532cbbaa3cd6823e6e358c8a95e0dde524b0b75d456a3b011f64c31d98

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