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

Uploaded Source

Built Distribution

muffin_rest-4.2.0-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.2.0.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for muffin-rest-4.2.0.tar.gz
Algorithm Hash digest
SHA256 2f587d83dbb3856c6615ee9351d08335c0c1f7d0b21d03f86a614a2daed95d4c
MD5 908082e4c9ead145c6b65879ba4b4880
BLAKE2b-256 1398a00eacb3b2871de47edbc14340c0ebf2a5a9d604d36ebc1dbf7ef75ebe48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.2.0-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for muffin_rest-4.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90cf81680c2cac85d3c505857638244df00946a73f53ea7a494c6d164ddd3aa4
MD5 20ee1453e42b25c9fcafa3954ec8329c
BLAKE2b-256 cf00684fe4d5ccf6eabc03b3ed719a0386c6b3c956c5445789bc1ecc88f245e4

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