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

Uploaded Source

Built Distribution

muffin_rest-4.2.6-py3-none-any.whl (32.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.2.6.tar.gz
  • Upload date:
  • Size: 25.6 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.2.6.tar.gz
Algorithm Hash digest
SHA256 aaeb3cf4aede478f2b900d7a6293970ede6c3e00ed03a133e7b5e61804830af7
MD5 9515a15ff1880c3bae7c1e054528d26e
BLAKE2b-256 f30356e39255e7a0842e61e7a9ed819ce51c0c30185d8ffb2221b689f065c313

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.2.6-py3-none-any.whl
  • Upload date:
  • Size: 32.9 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.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 fca8a7eecf6c7e49814a66333029b5d6aff3f0ac63fd800909a2cc6cb5920e53
MD5 3bd74b8d0a91ab03ed0d8c7614dc6381
BLAKE2b-256 c7503b86eb610e19edbbf8cd9caee89e21ff09a88e84992ad7ae9d7d9866b21e

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