Search Wagtail pages by block type.
Wagtail Inventory adds the ability to search pages in your Wagtail site by the StreamField block types they contain. It adds a new Settings menu to the Wagtail admin site that allows you to search for pages that do or do not contain certain blocks. It supports searching both by Wagtail built-in blocks (like
CharBlock) as well as any custom blocks you might define.
Install the package using pip:
$ pip install wagtail-inventory
wagtailinventory as an installed app in your Django settings:
# in settings.py INSTALLED_APPS = ( ... 'wagtailinventory', ... )
Run migrations to create required database tables:
$ manage.py migrate wagtailinventory
Run a management command to initialize database tables with current pages:
$ manage.py block_inventory
You should now be able to search your pages in the Wagtail admin site, under Settings > Block Inventory.
This code has been tested for compatibility with:
- Python 3.8+
- Django 3.2 (LTS), 4.0, 4.1
- Wagtail 2.15 (LTS), 3.0, 4.0, 4.1 (LTS)
It should be compatible with all intermediate versions, as well. If you find that it is not, please file an issue.
Running project unit tests requires tox:
To run the test app interactively, run:
$ tox -e interactive
Now you can visit http://localhost:8000/admin/ in a browser and log in with