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

Uploaded Source

Built Distribution

muffin_rest-8.0.0-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-8.0.0.tar.gz
  • Upload date:
  • Size: 25.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure

File hashes

Hashes for muffin_rest-8.0.0.tar.gz
Algorithm Hash digest
SHA256 b099780b18830025e955a6bf1cdaabcdd8ce992dfc602ec3937630f17919a353
MD5 a5b3eeb1f4554a2cc72cb8ceb89b4326
BLAKE2b-256 3675f30e0343645dbad7eaae974f53f59b805e7227f074082294d7e4d28525ae

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-8.0.0-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1024-azure

File hashes

Hashes for muffin_rest-8.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5868eda7632dff8843b75e6b1c33fa8d350ba89ae26b4950def383f6af2c62d5
MD5 5254b6d0c7812919e42c78e20bae14dd
BLAKE2b-256 f1765f8dfff7cc69327a782f89a2b2e521a7fc041278b5256e166c251208f323

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