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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-7.3.1.tar.gz
  • Upload date:
  • Size: 24.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.12 Linux/6.2.0-1012-azure

File hashes

Hashes for muffin_rest-7.3.1.tar.gz
Algorithm Hash digest
SHA256 40f73220148bd133e87f8cb5347c4b5112e2bd62a7dcdfc73404b1fa99ce0ff8
MD5 5445b8a8255c8b41a1c77cc193dc7639
BLAKE2b-256 879c659a50e17acbcc7b7dafdcb91d78b631fb8e43ac815b986c7b7cfecd4bbf

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-7.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c3a32855f48ff344ab52679d8f5f743c92775c05680264799ce9012190c45218
MD5 2220d4e7ec69253681153cd5facb2552
BLAKE2b-256 d649e69c7d73e4f77b167067b538004abce771971fbe7cb011c59582aa2725f4

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