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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-7.3.2.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.2.tar.gz
Algorithm Hash digest
SHA256 1edb0c2e4145503df39c4c6027421e775ff4155ed6391c2a8bd12c7564b77cc8
MD5 81fa95ee3af16290981f15b02a8f6f9b
BLAKE2b-256 f61f01ede7c7b2af7df640093597b25d31251bc8bbc30349814372b82e79671f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-7.3.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8f20a7f4153ea4d62802fa056afad9b0a10e6c6d7dd02113a9d50c1488f4ceb5
MD5 8d9a59df911f60c26e7c719c1a0e36e2
BLAKE2b-256 6a154d9149cbd9d36b77ecec824bb0162574ff064dad76b294e6e9af0cb4dd84

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