cfpb / wagtail-inventory

wagtail-inventory

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.

Setup

Install the package using pip:

$ pip install wagtail-inventory

Add 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.

Compatibility

This code has been tested for compatibility with:

• Python 3.6+
• Django 3.2 (LTS), Django 4.0 (Current)
• Wagtail 2.15 (LTS), Wagtail 2.16 (Current)

It should be compatible with all intermediate versions, as well. If you find that it is not, please file an issue.

Testing

Run unit tests with tox to test against select supported package combinations.

Open source licensing info

1. TERMS
2. LICENSE
3. CFPB Source Code Policy