Add initial version of wagtail-treemodeladmin #1

willbarton · 2018-05-11T17:52:40Z

This PR adds the initial version of wagtail-treemodeladmin. The README hopefully provides a decent overview of what this is.

Wagtail-TreeModelAdmin is an extension for Wagtail's ModelAdmin that allows for a page explorer-like navigation of Django model relationships within the Wagtail admin.

Implementationally, I've tried to make this as light-weight as possible. It extends ModelAdmin as little as possible to allow page explorer-style navigation from one model to another via a configured ForeignKey one-to-many relationship. It does this by having the fields for that relationship explicitly configured on the TreeModelAdmin subclass, and then adding the > column to the right of the object listing table as a link to the "child" model listing filtered for the parent. For example, given the models in the quickstart section of the README, the destination of the > link for the author with id 1 in the author list at the URL /admin/libraryapp/author/ will be /admin/libraryapp/book/?author=1.

Testing

There are a couple ways to see it work.

In isolation, install Django and Wagtail into a virtual environment (or activate one of the tox virtualenvs), and then run:
```
DJANGO_SETTINGS_MODULE=treemodeladmin.tests.settings django-admin.py loaddata treemodeladmin_test
DJANGO_SETTINGS_MODULE=treemodeladmin.tests.settings django-admin.py runserver
```
Then visit http://localhost:8000/admin. Author will be available under the "TreeModelAdmin Test" menu item.
As part of cfgov-refresh, assuming a working docker version with a recent database, checkout the treemodeladmin branch, rebuild your python docker container or otherwise install requirements/libraries.txt in your virtualenv:
```
docker-compose build python
docker-compose up
```
Then visit http://localhost:8000/admin. The Regulations 3000 models will be navigable via TreeModelAdmin under the "Regulations" menu item.

Todos

There is more to do after this PR, including:

Make breadcrumbs respect the parent-child relationships.

Currently the breadcrumb links are simply to the listing of all objects (so /admin/libraryapp/book/ instead of /admin/libraryapp/book/?author=1).
Make pre-fill parents in their respective fields in the Add view of child objects.

Currently if you're at /admin/libraryapp/book/?author=1 and you click the "Add" button, the author field is blank.
Bring button styles/spacing more in line with the page explorer.

The particular styles of the header on the page explorer are not available outside a specific class ancestry that seems too fragile to try to imitate in the ModelAdmin-like templates. This may require us to include out own stylesheet.

But this is intended to be a first iteration and proof-of-concept that we can work with for now as we fill out those features before releasing wagtail-treemodeladmin.

Checklist

Scotchester · 2018-05-11T17:57:24Z

A screenshot or two in the readme would be nice :)

higs4281

This is too slick for words.

I'd like to spend more time wth the PR, but I have some testing notes to pass along:

I had to add coverage to the tox.ini [testenv] deps to get tox to run.
If we want to test against wagtail20 we'll need to handle the admin module's name change from wagtail.wagtailadmin to wagtail.admin
I had to adjust your steps a bit to get scenario 1 (isolation) to run, and needed to add a migrate step to set up a test db:

export DJANGO_SETTINGS_MODULE=treemodeladmin.tests.settings
export PYTHONPATH='[PATH TO PROJECT]'
django-admin.py migrate
django-admin.py loaddata treemodeladmin_test
django-admin.py runserver

willbarton · 2018-05-14T14:27:08Z

A screenshot or two in the readme would be nice :)

@Scotchester Once we get the styling and appearance nailed down, I'll make sure to include one.

I had to add coverage to the tox.ini [testenv] deps to get tox to run.

Weird, @higs4281. I wiped everything out to be sure, but coverage is getting picked up via the pip install -e ".[testing]" line as it should be for me. Anyone else available to give it a go?

If we want to test against wagtail20 we'll need to handle the admin module's name change from wagtail.wagtailadmin to wagtail.admin

Embarrassing oversight on my part! It's now Wagtail 2.0-compatible (with some heavy borrowing from @chosak's wagtail-sharing settings)!

Scotchester · 2018-05-14T14:38:54Z

Once we get the styling and appearance nailed down, I'll make sure to include one.

Is that something you'd like help with?

chosak

Can you confirm: does this package create any models of its own, or only add admin/wrappings around models from other apps? I ask for database migration considerations.

chosak · 2018-05-14T14:47:36Z

README.md


-> Keep the README fresh! It's the first thing people see and will make the initial impression.
+Wagtail-TreeModelAdmin is an extension for Wagtail's ModelAdmin that allows for a page explorer-like navigation of Django model relationships within the Wagtail admin.


Link to ModelAdmin docs?

chosak · 2018-05-14T14:49:32Z

README.md

 ```

----
+2. Add `treemodeladmin` as an installed app in your Django `settings.py`:


On wagtail-sharing I added explicit documentation about its dependency on Wagtail ModelAdmin, as ModelAdmin is optional and isn't part of the standard Wagtail setup.

chosak · 2018-05-14T14:50:28Z

README.md


-## Getting help
+Then visit the Wagtail admin. `Library` will be in the menu, and will give you a list of authors, and each author will have a link that will take to their books.


Typo? "that will take [you] to their books".

chosak · 2018-05-14T14:52:05Z

setup.py

+
+try:
+    import pypandoc
+    long_description = pypandoc.convert('README.md', 'rst')


Is this conversion to RST still necessary now that PyPI properly supports Markdown READMEs?

Probably not. I'd like to do some experimentation though, considering that the Markdown support didn't work with the latest release of wagtail-flags.

chosak · 2018-05-14T14:53:58Z

tox.ini

+install_command=pip install -e ".[testing]" -U {opts} {packages}
+commands=
+    coverage erase
+    coverage run --source='treemodeladmin' {envbindir}/django-admin.py test {posargs}


How would you feel about adding a third coverage report line here? I've been thinking lately that this would be a good pattern to adopt in our packages, and I think I've seen @higs4281 use this. An advantage of including the report as part of the tox execution is that then you don't need to have coverage installed outside of the tox env to view the reports; a downside is for tox setups with many environments you might see the report many times (although, maybe this is good to ensure that the coverage is consistent across versions).

I actually like this idea a lot. I'll do it!

chosak · 2018-05-14T14:55:26Z

treemodeladmin/templates/treemodeladmin/includes/breadcrumb.html

@@ -0,0 +1,8 @@
+{% load i18n treemodeladmin_tags %}


Is treemodeladmin_tags needed here?

chosak · 2018-05-14T14:55:45Z

treemodeladmin/templates/treemodeladmin/includes/header.html

@@ -0,0 +1,24 @@
+{% load i18n modeladmin_tags treemodeladmin_tags %}


Is treemodeladmin_tags needed here?

willbarton · 2018-05-14T15:24:43Z

Can you confirm: does this package create any models of its own, or only add admin/wrappings around models from other apps? I ask for database migration considerations.

@chosak That is correct. The test app, treemodeladmintest, has migrations, but that won't be used in any deployed environment.

willbarton · 2018-05-14T15:28:08Z

Once we get the styling and appearance nailed down, I'll make sure to include one.

Is that something you'd like help with?

I'll rope @contolini into it when the time comes. I think we're just going to have to compile and provide our own custom CSS for it.

higs4281 · 2018-05-14T17:16:29Z

I had to add coverage to the tox.ini [testenv] deps to get tox to run.

After re-testing, I only encountered this when running bare tox with no env specified.

If others encounter this, maybe we could add a testing note about matrix options.

willbarton · 2018-05-15T14:18:07Z

Addressed review feedback. I'd like to merge this so that we can include it in cfgov-refresh and iterate on it with regulations3k.

@higs4281 @contolini any objections? @chosak @Scotchester?

Scotchester · 2018-05-15T15:01:33Z

Haven't tested it, but no objection.

Add initial version of treemodeladmin

f2a2d6b

willbarton requested review from higs4281 and contolini May 11, 2018 17:52

higs4281 reviewed May 11, 2018

View reviewed changes

Wagtail 2.0 compatibility

1decc3b

willbarton force-pushed the initial-work branch from ffee71a to 1decc3b Compare May 14, 2018 14:26

chosak reviewed May 14, 2018

View reviewed changes

Use Markdown for the long_description

0db4c77

willbarton added 3 commits May 15, 2018 09:22

Add coverage report to test environments

a1043ac

Add links to ModelAdmin and fix grammar

5e6b38b

Remove unnecessary template tag inclusion

d136f45

willbarton merged commit 2fee79c into master May 16, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add initial version of wagtail-treemodeladmin #1

Add initial version of wagtail-treemodeladmin #1

willbarton commented May 11, 2018

Scotchester commented May 11, 2018

higs4281 left a comment •

edited

Loading

willbarton commented May 14, 2018

Scotchester commented May 14, 2018

chosak left a comment

chosak May 14, 2018

chosak May 14, 2018

chosak May 14, 2018

chosak May 14, 2018

willbarton May 14, 2018

chosak May 14, 2018

willbarton May 14, 2018

chosak May 14, 2018

chosak May 14, 2018

willbarton commented May 14, 2018 •

edited

Loading

willbarton commented May 14, 2018

higs4281 commented May 14, 2018

willbarton commented May 15, 2018

Scotchester commented May 15, 2018


		> Keep the README fresh! It's the first thing people see and will make the initial impression.
		Wagtail-TreeModelAdmin is an extension for Wagtail's ModelAdmin that allows for a page explorer-like navigation of Django model relationships within the Wagtail admin.


		## Getting help
		Then visit the Wagtail admin. `Library` will be in the menu, and will give you a list of authors, and each author will have a link that will take to their books.

		@@ -0,0 +1,24 @@
		{% load i18n modeladmin_tags treemodeladmin_tags %}

Add initial version of wagtail-treemodeladmin #1

Add initial version of wagtail-treemodeladmin #1

Conversation

willbarton commented May 11, 2018

Testing

Todos

Checklist

Scotchester commented May 11, 2018

higs4281 left a comment • edited Loading

Choose a reason for hiding this comment

willbarton commented May 14, 2018

Scotchester commented May 14, 2018

chosak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

willbarton commented May 14, 2018 • edited Loading

willbarton commented May 14, 2018

higs4281 commented May 14, 2018

willbarton commented May 15, 2018

Scotchester commented May 15, 2018

higs4281 left a comment •

edited

Loading

willbarton commented May 14, 2018 •

edited

Loading