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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.3.0.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.0.tar.gz
Algorithm Hash digest
SHA256 cf682e962b0f8521b5580d8a5d3dbb0875edaf1ae040ab81634cda06462862db
MD5 7204b200e5e4da36cc6d73056bfba071
BLAKE2b-256 52335dd681fb251964047023531bd9d188a19c00441a8d8734e1c755bec54b96

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.3.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 45b69bca1e6e98e17467931c3e2f643d11a3c9a92c08be5945ca4011f5ee36f9
MD5 3d04389290e8bbb5ceeb8bc46c7b17fb
BLAKE2b-256 aa188b820c4a0e0bc6a66cbe19c0b4007440362f1fd305320f76b93ce694ee35

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