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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-4.6.7.tar.gz
Algorithm Hash digest
SHA256 085dd9d5a6fe210a16763b2f8213cd11ae6a509d640ff4b488f96561e6fd4456
MD5 4bb8261e44be847ad6538f90191c8722
BLAKE2b-256 80321f2abb010993b3540b6460f9e72dd412c1455a500f42c1d4097b8e3dcc19

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-4.6.7-py3-none-any.whl
Algorithm Hash digest
SHA256 05235628117f1daf5f1d612deaaa703eae89710ec1c61d091e45680b8955f1c2
MD5 d34498d31aace33826f28873e1ad0cd5
BLAKE2b-256 514f9d0f1cd276a920a797bf3cf19a1463cbd395beb56ca356ade9bf869d2f1d

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