Skip to main content

The package provides enhanced support for writing REST APIs with Muffin framework

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

Uploaded Source

Built Distribution

muffin_rest-6.0.3-py3-none-any.whl (35.2 kB view details)

Uploaded Python 3

File details

Details for the file muffin_rest-6.0.3.tar.gz.

File metadata

  • Download URL: muffin_rest-6.0.3.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-1042-azure

File hashes

Hashes for muffin_rest-6.0.3.tar.gz
Algorithm Hash digest
SHA256 f1660f744125cbf78a758d05e3668f8b188ef15030a43077ffa037c997653348
MD5 8b6db01d653e9449d8b24780d1f46c82
BLAKE2b-256 eb4d047b5a0eaf64991773b6fbe389a05da8838741d02cdca920fedf343001f9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-6.0.3-py3-none-any.whl
  • Upload date:
  • Size: 35.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.12 Linux/5.15.0-1042-azure

File hashes

Hashes for muffin_rest-6.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 76c143630b014a5fd6c9e3c45c005541ebc9a6bf9ac505689c650a1a58dfd7b2
MD5 720d8d49dfba5a10707f7130be53ae10
BLAKE2b-256 5bced391e4f79b3000897dab4853d210719667b4522dc29d7d3b7228ff0c14fd

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