Admin interface for 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 admin, api, muffin, asgi, asyncio, trio
  • Requires: Python >=3.7
Classifiers

Project description

https://raw.github.com/klen/muffin-admin/develop/.github/muffin-admin.png

Muffin-Admin – an extension to Muffin that implements admin-interfaces

Tests Status PYPI Version Python Versions

Features

Requirements

  • python >= 3.7

Installation

Muffin-Admin should be installed using pip:

pip install muffin-admin

With SQLAlchemy Core support:

pip install muffin-admin[sqlalchemy]

With Peewee ORM support:

pip install muffin-admin[peewee]

Usage

Initialize the admin:

from muffin_admin import Plugin

admin = Plugin(**options)

Initialize admin handlers (example for Peewee ORM):

from muffin_admin import PWAdminHandler

 @admin.route
 class UserResource(PWAdminHandler):

     """Create Admin Resource for the User model."""

     class Meta:

         """Tune the resource."""

         # Peewee Model for the admin resource
         model = User

         # Filters
         filters = 'email', 'created', 'is_active', 'role'

         # Tune serialization/deserialization schemas
         schema_meta = {
             'load_only': ('password',),
             'dump_only': ('created',),
         }

         # Columns to show
         columns = 'id', 'email', 'is_active', 'role', 'created'

         # Custom Material-UI icon
         icon = 'People'

Connect admin to an Muffin application:

admin.setup(app, **options)

For futher reference check https://github.com/klen/muffin-admin/tree/develop/examples <examples> in the repository.

Configuration options

Name

Default value

Description

prefix

"/admin"

Admin’s HTTP URL prefix

title

"Muffin Admin"

Admin’s title

custom_js_url

""

A link to custom JS file

custom_css_url

""

A link to custom CSS file

login_url

None

An HTTP URL for your custom authorization page

logout_url

None

An HTTP URL for your custom logout page

auth_storage

"localstorage"

Where to keep authorization information (localstorage|cookies)

auth_storage_name

muffin_admin_auth

Localstorage/Cookie name for authentication info

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-admin/issues

Contributing

Development of Muffin-Admin happens at: https://github.com/klen/muffin-admin

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 admin, api, muffin, asgi, asyncio, trio
  • Requires: Python >=3.7
Classifiers

Release history Release notifications | RSS feed

6.2.0

6.1.3

6.1.2

6.1.1

6.1.0

6.0.1

6.0.0

5.0.0

4.0.0

3.20.0

3.19.0

3.18.8

3.18.6

3.18.5

3.18.3

3.18.2

3.18.1

3.18.0

3.17.1

3.17.0

3.16.0

3.15.0

3.14.1

3.14.0

3.13.4

3.13.3

3.13.2

3.13.1

3.13.0

3.12.5

3.12.4

3.12.3

3.12.2

3.12.1

3.12.0

3.11.2

3.11.1

3.11.0

3.10.1

3.10.0

3.9.0

3.8.5

3.8.4

3.8.3

3.8.2

3.8.1

3.8.0

3.7.4

3.7.3

3.7.2

3.7.1

3.7.0

3.6.3

3.6.2

3.6.1

3.5.0

3.4.2

3.4.1

3.4.0

3.3.12

3.2.2

3.2.1

3.2.0

3.1.2

3.1.1

3.1.0

3.0.3

3.0.2

3.0.0

2.9.2

2.9.1

2.9.0

2.8.2

2.8.0

2.7.3

2.7.2

2.7.0

2.6.7

2.6.6

2.6.5

2.6.4

2.6.2

2.6.1

2.6.0

2.5.4

2.5.3

2.5.2

2.5.1

2.5.0

2.4.0

2.3.13

2.3.12

2.3.9

2.3.7

2.3.6

2.3.5

2.3.4

2.3.3

2.3.1

2.3.0

2.2.1

2.2.0

2.1.0

2.0.0

1.45.8

1.45.7

1.45.6

1.45.5

1.45.4

1.45.3

1.45.2

1.45.1

1.45.0

1.44.4

1.44.3

1.44.2

1.44.1

1.44.0

1.43.0

1.42.1

1.42.0

1.41.1

1.40.0

1.39.2

1.39.1

1.39.0

1.38.4

1.38.3

1.38.2

1.38.1

1.38.0

1.37.4

1.37.1

1.37.0

1.36.8

1.36.7

1.36.6

1.36.5

1.36.4

1.36.3

1.36.2

1.36.1

1.36.0

1.35.1

1.35.0

1.34.0

1.33.1

1.32.6

1.32.5

1.32.4

1.32.2

1.31.3

1.31.2

1.31.1

1.31.0

1.30.0

1.29.0

1.28.2

1.28.1

1.28.0

1.27.2

1.26.1

1.26.0

1.25.1

1.25.0

1.24.5

1.24.4

1.24.3

1.24.2

1.24.1

1.24.0

1.23.6

1.23.5

1.23.4

1.23.3

1.23.2

1.21.1

1.21.0

1.20.0

1.19.2

1.19.1

1.18.2

1.18.1

1.17.0

1.16.0

1.15.0

1.14.4

1.14.3

1.14.1

1.13.0

1.12.1

1.12.0

1.11.1

1.11.0

1.10.0

1.9.0

1.8.1

1.7.2

1.7.1

1.7.0

1.6.0

1.5.0

1.4.1

1.4.0

1.3.0

1.2.0

1.1.2

1.1.1

This version

0.22.5

0.22.3

0.22.2

0.22.1

0.22.0

0.21.0

0.20.2

0.20.1

0.11.7

0.11.6

0.11.5

0.11.4

0.11.3

0.11.2

0.11.1

0.11.0

0.10.1

0.10.0

0.9.1

0.9.0

0.8.0

0.7.2

0.7.1

0.7.0

0.6.1

0.6.0

0.5.9

0.5.7

0.5.6

0.5.5

0.5.3

0.5.2

0.5.1

0.5.0

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.3.0

0.2.1

0.2.0

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.23

0.0.22

0.0.21

0.0.20

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.8

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

muffin-admin-0.22.5.tar.gz (649.6 kB view details)

Uploaded Source

Built Distribution

muffin_admin-0.22.5-py3-none-any.whl (651.2 kB view details)

Uploaded Python 3

File details

Details for the file muffin-admin-0.22.5.tar.gz.

File metadata

  • Download URL: muffin-admin-0.22.5.tar.gz
  • Upload date:
  • Size: 649.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for muffin-admin-0.22.5.tar.gz
Algorithm Hash digest
SHA256 04947435093c6bc0091402dddf0967dbe6f6785052c1c112e657ce67dee363c5
MD5 efdb387058b814bbe614160681f5c517
BLAKE2b-256 66b64cb6a4dbdcc0ed2f28b0f826eb88f7006a25776e2752f6d6fd65d090704f

See more details on using hashes here.

File details

Details for the file muffin_admin-0.22.5-py3-none-any.whl.

File metadata

  • Download URL: muffin_admin-0.22.5-py3-none-any.whl
  • Upload date:
  • Size: 651.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5

File hashes

Hashes for muffin_admin-0.22.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4dbfa1012d73d3ddc80d186232ceed32571b5da5d03ab05943785eb5e07115b5
MD5 dc93cc32b92d128831c130f211cef622
BLAKE2b-256 2334ee65fa2fbfd98dacce6027d5fd3e241d1866d721c10963c0bec30aeeb3aa

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