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

Uploaded Source

Built Distribution

muffin_rest-4.0.1-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.0.1.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for muffin-rest-4.0.1.tar.gz
Algorithm Hash digest
SHA256 464c191f1d65244dfe1ff1f8a1839298643b8ac03fc37cae878fd74623927203
MD5 4771d1da02ead567f7479f6a23d90514
BLAKE2b-256 84cfa7ef44a9b717bb6958a14e4e34db06c323c0be00f198bd6d30e5f487a582

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.0.1-py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.8

File hashes

Hashes for muffin_rest-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5765474b3a3b7472f33986de1028e8735f07b7e53e5560e7989be04a19c9c07a
MD5 4f00c9a9f42224f7284932ba6244a46d
BLAKE2b-256 52539e699e55e2b6ca6c4ad822f949ade499a745d952c5981f14465180b92284

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