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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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