Skip to main content

the package provides enhanced support for writing REST APIs with Muffin_.

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

Uploaded Source

Built Distribution

muffin_rest-4.3.1-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

Details for the file muffin-rest-4.3.1.tar.gz.

File metadata

  • Download URL: muffin-rest-4.3.1.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for muffin-rest-4.3.1.tar.gz
Algorithm Hash digest
SHA256 7ed3a616af9c0801b01789220534b6532a72bbc351bbc8c8f29fde43db1b44ac
MD5 47ec2c3a8378474075104fb0dd613e46
BLAKE2b-256 3ea5937b7aaac52a0b782b76f5801cbdbdb49bca9021870f00543ca9d6b56111

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.3.1-py3-none-any.whl
  • Upload date:
  • Size: 33.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.2

File hashes

Hashes for muffin_rest-4.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c538c09d963e7d8a09d68407c8fe5c6922edb9101b98af22284a882c9cacda21
MD5 7510716b1bc44806bf51d2be969685d8
BLAKE2b-256 f02922ee00438c12a70fbfea7b2ed42d12c18a4b3f7c99408311afb7c858f440

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