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

This version

4.9.0

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

Uploaded Source

Built Distribution

muffin_rest-4.9.0-py3-none-any.whl (34.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-4.9.0.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.15.0-1036-azure

File hashes

Hashes for muffin_rest-4.9.0.tar.gz
Algorithm Hash digest
SHA256 ea49897018352170966d26e02c601eb9fed82b88ed4ee5e4fd50d3e11ade13aa
MD5 2cb3b879a2b7673ef9163fb43d30db5e
BLAKE2b-256 c728143a2313a48f21ebfc944bd97f417c02e418f67385938b8d3c2dd1795c44

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.9.0-py3-none-any.whl
  • Upload date:
  • Size: 34.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.2 CPython/3.10.6 Linux/5.15.0-1036-azure

File hashes

Hashes for muffin_rest-4.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 63591c481552f4fc04b99f7336f1713774ee2d648983cdc6166256af8cfe8fe0
MD5 2f97c05f1b1746d3bfec031e27f5c521
BLAKE2b-256 73045a8ca884b394dc4fea413c5e75d44f0a890f70fe63dbba9db52fc7f0b889

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