A simple and powerful admin for Piccolo models, using ASGI.
Project description
Piccolo Admin
piccolo_admin provides a simple yet powerful admin interface on top of Piccolo models - allowing you to easily add / edit / filter your data.
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.
For example, using Starlette routes:
from piccolo_admin.endpoints import AdminRouter
from starlette.routing import Router, Route
import uvicorn
from my_project.tables import Director, Movie
from my_project.endpoints import create_admin
admin = create_admin([Director, Movie])
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
You will need to configure a local webserver as a proxy - see extra/piccolo_admin.
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
Built Distribution
Hashes for piccolo_admin-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0e18ad89562c6fefe1574c2fd87d089e913baef07850a1310cbd3fb39159e6b6 |
|
MD5 | aa6344ce755080abc350c067b7eb5288 |
|
BLAKE2b-256 | 24c5dc5148ef801748dac03654006af5ffb085aab26fb4b5bf88da6d4902ecad |