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

Uploaded Source

Built Distribution

muffin_rest-7.3.5-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-7.3.5.tar.gz
  • Upload date:
  • Size: 24.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1023-azure

File hashes

Hashes for muffin_rest-7.3.5.tar.gz
Algorithm Hash digest
SHA256 8c0de304cccc0064f8ecc166eeee3ba9af830bfeeb59f7c091b00f2471587a87
MD5 211c70aa0f217b61dabc6a340ec8ffac
BLAKE2b-256 b7fbe323a08c895bab8a91d7da84e8faed52d4898de530767f9e3243d7ac77cb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-7.3.5-py3-none-any.whl
  • Upload date:
  • Size: 35.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1023-azure

File hashes

Hashes for muffin_rest-7.3.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0d8a908db9ef4e7567ae55cf82ece9fbd5f0b6b63d01f3c044f2fd4d06709bce
MD5 8ed8f61a34ad7408df47057a44e2c8c2
BLAKE2b-256 099813837e7a46f3d88b169f0705772f423caf1c0d2a94f1c0e5c2be2085bd08

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