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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-4.6.6.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.6.tar.gz
Algorithm Hash digest
SHA256 de3c37f47b95f783beded0d7799a0fd80ef48d0d2f28c2e5e29bb5a69cb7fc1e
MD5 707a1fa28b8963cac9256cb2b26928d3
BLAKE2b-256 e70e04246b54f62157fb91d3da7649eea1f71182a6a63a042910d96a569c364f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.6.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 d7695765c93e6079277442f7ff90ce2bcc8c581c31032316bbab1a3bd6bab1b4
MD5 4ee17e2bc780b3f56fdbadc1c22b7382
BLAKE2b-256 a87589ddba40a55a75980698a4b3ef4f041b9de23d9499912afe2a0d30dc1ed1

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