Support for grouping of tables in the Admin UI

[sumitsharansatsangi]

For a project with lots of tables under different app requires grouping of tables.

Django provide it by creating the section with the App label ( Don't know, is there an option to customise the name too, haven't explored).

In piccolo, if grouping of table can be provided with the custom naming support (default with the App label) can be very helpful.

You can also provide an option to choose grouping of tables or not too.

[dantownsend]

Yes, it's an interesting idea.

You can override the table name:

class Post(Table, tablename="blog_post"):
    ...

But I think what you're suggesting is dividing the sidebar in Piccolo Admin by app would be useful.

We could do something like:

create_admin(tables=[
    TableConfig(Director, group='Movies'),
    TableConfig(Movie, group='Movies'),
    TableConfig(Studio, group='Movies'),
    TableConfig(Band, group='Music'),
    TableConfig(Manager, group='Music'),
])

[sinisaos]

@sumitsharansatsangi You need to use argument menu_group not group_admin in create_admin.

[sumitsharansatsangi]

Traceback (most recent call last):
  File "/home/sumit/PycharmProjects/testProj/admin.py", line 47, in <module>
    create_admin(
  File "/home/sumit/.cache/pypoetry/virtualenvs/test-proj-cxiQj_a7-py3.11/lib/python3.11/site-packages/piccolo_admin/endpoints.py", line 1098, in create_admin
    return AdminRouter(
           ^^^^^^^^^^^^
  File "/home/sumit/.cache/pypoetry/virtualenvs/test-proj-cxiQj_a7-py3.11/lib/python3.11/site-packages/piccolo_admin/endpoints.py", line 448, in __init__
    with open(os.path.join(ASSET_PATH, "index.html")) as f:
         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FileNotFoundError: [Errno 2] No such file or directory: '/home/sumit/.cache/pypoetry/virtualenvs/test-proj-cxiQj_a7-py3.11/lib/python3.11/site-packages/piccolo_admin/dist/index.html'

I think above is probably because of latest version of pathspec package. I can be wrong, but I request you to try with latest pathspec library.

[sinisaos]

@sumitsharansatsangi Sorry but I don't understand. That error says that you don't have dist folder in Piccolo Admin and you must build frontend using npm run build. You need fresh virtualenv. Then download zip from here . I one terminal cd in piccolo_admin and install dependencies using pip install and after that run server with python -m piccolo_admin.example.
I second terminal cd into piccolo_admin/admin_ui and run npm install, npm run build(to build dist folder) and then npm run serve. Then you can go to http://localhost:3000 and log in to admin.
If you want to use this in your existing project, simply copy the piccolo_admin (folder inside piccolo_admin) and paste it into site-packages, change create_admin to use TableConfig(..., menu_group="Something") and you're good to go.

[sumitsharansatsangi]

@sinisaos , The admin page has no table now, have I missed something ?

[sinisaos]

@sumitsharansatsangi I don't know, everything is fine on my side. I always double-check the code before PR.

Maybe you forgot to add menu_group to TableConfig, but that shouldn't be a problem since menu_group is optional and if you don't use it, you get default menu without groups.