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.3

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-5.1.3.tar.gz
Algorithm Hash digest
SHA256 41248e7e9590b0b8521fce37ea2732ec4b47e8a2e49cd3da6fee7c31ce70b9d9
MD5 ba31b0cb9f045d727ffc55b4324dcb04
BLAKE2b-256 422daaa62d6587b7b7ca084f1c613edf386631ae91caf825814ab5cb4f129dfc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-5.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ac683c335fc5323998a8f3733b795ede11d872b8179b34906f1988862f26a0d6
MD5 0f43f23e1e72c3eafe5f4a7d3c79cc95
BLAKE2b-256 4004e2e6a8dcfd212667750b01ba87219394b1a9b0fe08066b240b621f358cc4

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