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

Uploaded Source

Built Distribution

muffin_rest-5.1.11-py3-none-any.whl (34.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-5.1.11.tar.gz
  • Upload date:
  • Size: 24.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Linux/5.15.0-1038-azure

File hashes

Hashes for muffin_rest-5.1.11.tar.gz
Algorithm Hash digest
SHA256 0476e15626016d2379cef96326a9596269449056f0ec21ae1542265bde80daa3
MD5 567d1a17d87cf291a79e442ba4a05ceb
BLAKE2b-256 545cff8e1b41abb559ff20d3d69139bad9b95388b9fbb533d44cc5d8f2312a23

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-5.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 dce509eb115f23656b1edb5659fccedbc2e85a16083cb996ec8507f1e01eadc7
MD5 75ff792a093562566ff6b8bd083bd181
BLAKE2b-256 5fb4fa964b15823306d00f5f3e887b482933f0c4ddb713f397801423a4b989e8

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