The package provides enhanced support for writing REST APIs with Muffin framework

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for klen from gravatar.com klen

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Kirill Klenov
  • Tags rest, api, muffin, asgi, asyncio, trio
  • Requires: Python >=3.8, <4.0
Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for klen from gravatar.com klen

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Kirill Klenov
  • Tags rest, api, muffin, asgi, asyncio, trio
  • Requires: Python >=3.8, <4.0
Classifiers

Release history Release notifications | RSS feed

9.3.0

9.2.0

9.1.1

9.0.0

8.1.0

8.0.0

7.3.5

7.3.4

7.3.3

7.3.2

7.3.1

7.2.1

7.2.0

7.1.0

7.0.0

6.0.3

6.0.1

6.0.0

5.2.0

5.1.14

5.1.11

5.1.10

5.1.9

5.1.8

5.1.7

5.1.6

5.1.5

5.1.4

5.1.3

5.1.2

5.1.1

5.1.0

5.0.2

5.0.1

5.0.0

4.9.0

4.8.8

4.8.7

4.8.6

4.8.5

4.8.1

4.8.0

4.7.1

4.7.0

4.6.7

4.6.6

4.6.5

4.6.4

4.6.3

4.6.2

4.6.1

4.5.2

4.5.1

This version

4.5.0

4.4.3

4.4.2

4.4.1

4.4.0

4.3.3

4.3.2

4.3.1

4.3.0

4.2.7

4.2.6

4.2.5

4.2.4

4.2.3

4.2.2

4.2.1

4.2.0

4.1.3

4.1.2

4.1.1

4.0.2

4.0.1

4.0.0

3.5.1

3.5.0

3.4.4

3.4.3

3.4.1

3.4.0

3.3.3

3.3.1

3.3.0

3.2.0

3.1.1

3.1.0

3.0.1

3.0.0

2.8.0

2.7.4

2.7.2

2.7.1

2.7.0

2.6.5

2.6.4

2.6.1

2.6.0

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.1

2.4.0

2.3.3

2.3.2

2.3.1

2.3.0

2.2.5

2.2.4

2.2.3

2.2.2

2.2.0

2.1.10

2.1.9

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.1

2.0.0

1.6.9

1.6.8

1.6.7

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.1

1.5.0

1.4.1

1.4.0

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.1

1.0.0

0.4.4

0.4.3

0.4.2

0.4.0

0.3.1

0.3.0

0.2.2

0.2.1

0.2.0

0.1.2

0.1.1

0.1.0

0.0.33

0.0.32

0.0.31

0.0.30

0.0.29

0.0.28

0.0.27

0.0.26

0.0.25

0.0.24

0.0.23

0.0.22

0.0.21

0.0.20

0.0.19

0.0.18

0.0.17

0.0.16

0.0.15

0.0.14

0.0.13

0.0.12

0.0.11

0.0.10

0.0.9

0.0.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

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

Uploaded Source

Built Distribution

muffin_rest-4.5.0-py3-none-any.whl (34.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: muffin_rest-4.5.0.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.4.0 CPython/3.10.6 Linux/5.15.0-1034-azure

File hashes

Hashes for muffin_rest-4.5.0.tar.gz
Algorithm Hash digest
SHA256 3416be8d4919d086e605402c1f83ba6a19f01320cc1bfe82876718c8f4bb79d3
MD5 5bdd15763ba67ffbc09859361073bfaa
BLAKE2b-256 79f3f36c93ad56161fd68bdb1590db1131c472ae26bfbdcf0d4da3c4829ace3c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for muffin_rest-4.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ff5a52be454e8fc00ca5078901444c15ed4fd28e889c4e4303a9681ec327960f
MD5 c3b91223e32ac651b9153be23182c9fb
BLAKE2b-256 ea77ca5bb8b3429cea86f11e3d97656ada744e3377767b027e219e1925573aa1

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