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 report 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
Admin users should now be able to search pages in the Wagtail admin site, under Reports > Block Inventory.
Other user groups may be granted access to the report by giving them the “Can view” “Page block” permission in Wagtail Group settings.
Compatibility
This code has been tested for compatibility with:
Python 3.12, 3.13, 3.14
Django 5.2 (LTS), 6.0
Wagtail 7.0 (LTS), 7.3, 7.4 (LTS)
It should be compatible with all intermediate versions, as well. If you find that it is not, please file an issue.
Testing
Running project unit tests requires tox:
$ 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 admin / changeme.
Open source licensing info
Release files for wagtail-inventory 3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| wagtail_inventory-3.4.tar.gz | 21.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| wagtail_inventory-3.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 42.6 kB
Release files / wagtail_inventory-3.4.tar.gz
| Download URL | wagtail_inventory-3.4.tar.gz |
|---|---|
| Size | 21.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d13043c1ca6444cfe5003606a91e26f20f989223373223893e5693794b6225ea
|
|
BLAKE2b-256 checksum How to use checksums |
23a879070be886ac7d0be86b1efdbc1b7960d1396449e274c63b4b80866ddeeb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency logRelease files / wagtail_inventory-3.4-py3-none-any.whl
| Download URL | wagtail_inventory-3.4-py3-none-any.whl |
|---|---|
| Size | 21.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c2f75eaae683b18fd10450b1e4d397fa2ac13f2b3d09bdac7743a3c1d79b57cf
|
|
BLAKE2b-256 checksum How to use checksums |
2cc606d50f715c6aafd3282429b59094c0ac971f1ac1a150bb76700a67dbb1dd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 30, 2026.
Transparency log