Skip to main content

the package provides enhanced support for writing REST APIs with Muffin_.

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

Uploaded Source

Built Distribution

muffin_rest-4.2.3-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file muffin-rest-4.2.3.tar.gz.

File metadata

  • Download URL: muffin-rest-4.2.3.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for muffin-rest-4.2.3.tar.gz
Algorithm Hash digest
SHA256 604f3f28aae05c6f96accf2c0ded52dff772bd2f36aac96dd366c4616314e03b
MD5 ab0c40add296f23e5344b5586b092d43
BLAKE2b-256 26b9260151aa5c5d0f35c666a45ce16a67b468563357ff59214d840b38dd37c3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: muffin_rest-4.2.3-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.1

File hashes

Hashes for muffin_rest-4.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bd365e82271e1a20c822963c55ac8e8c2c1fa388f0b48eea5d398086719c2cc9
MD5 f9e993b150051b7c0393039384b30f78
BLAKE2b-256 6ab8180438948fc7685e542182a52abe65ce05b57b6483603b2d6cdced88117a

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