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

Uploaded Source

Built Distribution

muffin_rest-4.1.1-py3-none-any.whl (30.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-4.1.1.tar.gz
  • Upload date:
  • Size: 23.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for muffin-rest-4.1.1.tar.gz
Algorithm Hash digest
SHA256 ab9e2207429e9f2324c53de6c4f02f71e2ab72ab4e3689740947df3ed881a399
MD5 10332546c19a2cf4c77a0f34eb23388e
BLAKE2b-256 394b1e85c83608c40d3177ffed03a693c56aaab5f4fcc8bd2251e08690780b05

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 30.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.1 pkginfo/1.8.2 requests/2.27.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for muffin_rest-4.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27aeef8285f19c3783a541d22e292f97391bfa36042e68b5c69eef85f1c57bb1
MD5 ab300b3bee4db2368f086fa39ed0f1e2
BLAKE2b-256 b4e875bf4fa6ae4df2c424d0da8f1d3a629cf2db8da32e88c76e454fa1e4bf82

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