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

Uploaded Source

Built Distribution

muffin_rest-2.7.0-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-2.7.0.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for muffin-rest-2.7.0.tar.gz
Algorithm Hash digest
SHA256 da98d6d61520599360f2ea0cd174685bcfb36aea7f8a1580c71d3e6c78c93d4c
MD5 e85dacae956b463e2f1ab9e19d3f14f2
BLAKE2b-256 135e7eed96db0698c077c03494dc8435d04b22535b008ac799191a7439843996

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-2.7.0-py3-none-any.whl
  • Upload date:
  • Size: 25.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for muffin_rest-2.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f88ad86682b3ad1e12ca3c3fa6fea7f6e3a3ec4e36004552476f506c7421e256
MD5 4e98222cf7c27b5abeb8936c3fea3e39
BLAKE2b-256 442b5ba5d2f93cc44f8aaf6bcde669c430db301513a8c9362eb51774c793f070

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