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

6.0.0

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

Uploaded Source

Built Distribution

muffin_rest-6.0.0-py3-none-any.whl (35.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-6.0.0.tar.gz
Algorithm Hash digest
SHA256 d36e995e576777052dfd8e426a1bdd129cd3f0d17be32dfcf41d66411aa4230d
MD5 2071440ee7339982dcef55656aef3200
BLAKE2b-256 3e8def759be8caf12d42ecb1418d3b7a3de8e7b121c96778e09c9d17d59de346

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f407ce406c738a07e1e2aab0d2424c726f6bbabbbb102c86b00792001d48d007
MD5 e52ed2c38820bab5aba1c31fdb0ef8cf
BLAKE2b-256 5eac37712fac7a64be06e251ad1ffa2075e487b00b48cdf5b36ec6afd6cf09c2

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