1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72An admin dashboard for use with ASGI web frameworks.
**`dashboard` is still under development: We recommend pinning any dependencies with `dashboard~=0.1`**
**example.py**
```python
from starlette.applications import Starlette
from starlette.routing import Mount, Route
from starlette.responses import RedirectResponse
from starlette.staticfiles import StaticFiles
import databases
import dashboard
import orm
import datetime
database = databases.Database("sqlite:///test.db")
models = orm.ModelRegistry(database=database)
statics = StaticFiles(packages=["dashboard"])
class Notes(orm.Model):
registry = models
tablename = "notes"
fields = {
"id": orm.Integer(title="ID", primary_key=True),
"created": orm.DateTime(
title="Created", default=datetime.datetime.now, read_only=True
),
"text": orm.String(title="Text", max_length=100),
"completed": orm.Boolean(title="Completed", default=False),
}
admin = dashboard.Dashboard(
tables=[
dashboard.DashboardTable(
ident="notes", title="Notes", datasource=Notes.objects.order_by("-id")
),
]
)
routes = [
Mount("/admin", app=admin, name="dashboard"),
Mount("/statics", app=statics, name="static"),
Route("/", endpoint=RedirectResponse(url="/admin")),
]
app = Starlette(
debug=True,
routes=routes,
on_startup=[database.connect],
on_shutdown=[database.disconnect],
)
```
Rough installation...
```shell
$ virtualenv venv
$ venv/bin/pip install dashboard
$ venv/bin/python
>>> from example import models
>>> models.create_all()
$ venv/bin/uvicorn example:app
```
With many thanks to Eren Güven ([Twitter](https://twitter.com/cyberfart), [GitHub](https://github.com/eguven/)) for the `dashboard` PyPI package name.