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

Uploaded Source

Built Distribution

muffin_rest-4.2.1-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.2.1.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for muffin-rest-4.2.1.tar.gz
Algorithm Hash digest
SHA256 75f8b6ecaa6935802b602a2a0978e2e08222bca0c59c9c7e54aa0b93e962977f
MD5 89e30db356a4339eb7fa26681d09eeae
BLAKE2b-256 9ad5cb39d10efaea6baef544bc1c55bfbeca45dd9873db343ad136dbf8fe3ac1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.2.1-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for muffin_rest-4.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 36403f8ad80ca4166fce1095fb7012402fc8fa2dc1e3f4660ff7ea64a504f896
MD5 a5661e3afed57e87175c929d45a35ae6
BLAKE2b-256 7a23656841ac8d575dc269ffeb520bccfe56e875a565c1c3eb0379f90af15ef4

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