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

This version

5.1.7

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

Uploaded Source

Built Distribution

muffin_rest-5.1.7-py3-none-any.whl (34.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-5.1.7.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Linux/5.15.0-1039-azure

File hashes

Hashes for muffin_rest-5.1.7.tar.gz
Algorithm Hash digest
SHA256 b6f8ee1286c743db5d534333c257c5ec6ec556f96e88b47fd6ee06953b314091
MD5 a9daf8e0a4bca7a2c84ed3a0f490b677
BLAKE2b-256 98864cc0f19ece5608dbbb93697acfdc58bc6317d09d0ef9d34daccc45766607

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-5.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 e7bf44338df151a3663ddd950bfda3583f86bfc7e0366b6e24a522342ba0a082
MD5 c0cf84504e67fce3f2320812619e430e
BLAKE2b-256 f0a803c1394fb320ca6f46b6e2ea2f7569ac0d035f1f198e7938d4c85dbb05e2

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