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

Uploaded Source

Built Distribution

muffin_rest-4.3.2-py3-none-any.whl (33.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.3.2.tar.gz
  • Upload date:
  • Size: 25.7 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.3.2.tar.gz
Algorithm Hash digest
SHA256 e5ec2f1abeb056e86d20d6d622b1a8b2eeeee0cf784bdf08e1eaff5c12bfa234
MD5 b0e47532b6e5dc4b6103cc7518e3efe6
BLAKE2b-256 4927dc4e1666d633bec18d1d333447bdafe9bead16fc280b61754968ee2dee8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.3.2-py3-none-any.whl
  • Upload date:
  • Size: 33.1 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.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 93328ac1129b6b1e849ef491beaaabd55515256fac469ca29719949be1b2ffe9
MD5 be852a38eee71ad66fb85db50b585d71
BLAKE2b-256 c1d03d05422f8e25f20227116c0a4df57ede0039e2a0d6d749b22a1a10db3a35

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