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

Uploaded Source

Built Distribution

muffin_rest-3.3.3-py3-none-any.whl (30.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin-rest-3.3.3.tar.gz
  • Upload date:
  • Size: 22.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for muffin-rest-3.3.3.tar.gz
Algorithm Hash digest
SHA256 723286783420acf84d8ab6117ee5748e27b18deff815e5f8851c7d8ad9cf2923
MD5 77228d80ef7ea563b82f2c30dce9723d
BLAKE2b-256 09a1edc854948658335b8bea55e5d9c37dfb2f4a602d211dd515dedc8a4db617

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-3.3.3-py3-none-any.whl
  • Upload date:
  • Size: 30.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for muffin_rest-3.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8d07da8c070360115bbe84b8eb01922b0d88ac98dbe85b5b7f61a8e360bb5ae6
MD5 5a644647f9281f22f33368282d6610bb
BLAKE2b-256 ad97190438510ef09e11b3e1ff62241e48330e9c39d3ac157e0ae20757397b3a

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