Skip to main content

A simple and powerful admin for Piccolo models, using ASGI.

Project description

Logo

Piccolo Admin

Documentation Status

Piccolo Admin provides a simple yet powerful admin interface on top of Piccolo tables - allowing you to easily add / edit / filter your data.

Screenshot

It was created at a design agency to serve the needs of customers who demand a high quality, beautiful admin interface for their websites. Our goal is to create a world class admin interface, akin to Wordpress or Django.

It's built using the latest technologies, with Vue JS on the front end, and a modern REST backend.

Try it

Try it online (username: piccolo, password: piccolo123).

Local Demo

To run a demo locally, using Python 3.7 or above:

pip install piccolo_admin
admin_demo

And then just launch localhost:8000 in your browser.

To see what happens behind the scenes, see piccolo_admin/example.py.

In a few lines of code we are able to:

  • Define our models
  • Setup a database
  • Create a REST API
  • Setup a web server and admin interface

ASGI

Since the admin is an ASGI app, you can either run it standalone like in the demo, or integrate it with a larger ASGI app such as FastAPI and Starlette.

For example, using Starlette routes:

from piccolo_admin.endpoints import create_admin
from starlette.routing import Router, Route
import uvicorn

from my_project.tables import Director, Movie


# The `allowed_hosts` argument is required when running under HTTPS. It's used
# for additional CSRF defence.
admin = create_admin([Director, Movie], allowed_hosts=['my_site.com'])


router = Router([
    Route(path="/", endpoint=Hello),
    Mount(path="/admin/", app=admin),
])


if __name__ == '__main__':
    uvicorn.run(router)

Full docs

Full documentation is available on Read the docs.

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

piccolo_admin-0.20.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

piccolo_admin-0.20.0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file piccolo_admin-0.20.0.tar.gz.

File metadata

  • Download URL: piccolo_admin-0.20.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.11.1 pkginfo/1.8.2 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for piccolo_admin-0.20.0.tar.gz
Algorithm Hash digest
SHA256 d18f3bae4f326a4c159b0667eb8989208e30f4505bc23b621b32d3d2f81b88e0
MD5 0f04d72157f32d67e6d31c67122fb607
BLAKE2b-256 3653fec5fae7cc92bdfa8d68ae4cf3125026a4df214d100c370091466ec47d44

See more details on using hashes here.

File details

Details for the file piccolo_admin-0.20.0-py3-none-any.whl.

File metadata

  • Download URL: piccolo_admin-0.20.0-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.11.1 pkginfo/1.8.2 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.10

File hashes

Hashes for piccolo_admin-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b45036efbb80dafdcca8443c10d1c533885dac579ebe55fb07db1ece2ee12dca
MD5 970d570360ff17581f16813baf8b7808
BLAKE2b-256 0c5a8dd221d70bb428c18754ea164927f91d40f7dab8637e3293fa8ab3954a3d

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