Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

Project description

Piccolo Admin

piccolo_admin provides a simple admin interface on top of Piccolo models.

Screenshot

Demo

To run a demo, 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.

For example, using Starlette routes:

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

from my_project.tables import Movie, User
from my_project.endpoints import Hello


admin = AdminRouter(Movie, auth_table=User)


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


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

Contributing

The backend is just vanilla Python.

The front end is built using Vue.js. To make modifications, clone the repo, and cd into the admin_ui directory.

Install the npm dependencies:

npm install

And then you can launch the admin as follows:

npm run serve

It will auto refresh the UI as you make changes to the source files.

The UI needs an API to interact with - the easiest way to do this is to use the demo app.

admin_demo

# Or alternatively
python -m piccolo_admin.example

Project details


Download files

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

Files for piccolo-admin, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size piccolo_admin-0.2.0-py3-none-any.whl (1.2 MB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size piccolo_admin-0.2.0.tar.gz (584.6 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page