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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-2.6.5.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.6.5.tar.gz
Algorithm Hash digest
SHA256 df3ea07a0cf23de9fc41dddc0b2b70d89684da49a7cd78f2e0c959efb6e60ade
MD5 7f5db7f3382c86b694362f503aa1bc0f
BLAKE2b-256 345c9fef2cee64b724acce35a9d3065c77cba1feaa51ec95eae57e1b96e9b7f3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-2.6.5-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.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 1cb413ce2f8406c11304f58eac3dab0df9b2d1a54a175146a16e55b7e7843b52
MD5 72bd4cd6ca483d1ca26406b6294db325
BLAKE2b-256 038e68905110ba170c536cb13cbe78209d3fff8a87cfe6c7a13bfbf979a0a0c1

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