Skip to main content

Wagtail report to filter pages by block content

Project description

Build Status

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.8, 3.12

  • Django 4.2 (LTS), 5.0, 5.1

  • Wagtail 6.2, 6.3 (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

  1. TERMS

  2. LICENSE

  3. CFPB Source Code Policy

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtail_inventory-3.1.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

wagtail_inventory-3.1-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_inventory-3.1.tar.gz.

File metadata

  • Download URL: wagtail_inventory-3.1.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for wagtail_inventory-3.1.tar.gz
Algorithm Hash digest
SHA256 203748a7eb15191852360682bf01400adeff12c74fb8079ff1c5452295dda524
MD5 b8ad307ab09abd8dc89152998e7b165d
BLAKE2b-256 967801e5173dc88dfbd8ce34871d111a36e56cde4d231e1d7b83c8e573a817f4

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_inventory-3.1.tar.gz:

Publisher: release.yml on cfpb/wagtail-inventory

Attestations:

File details

Details for the file wagtail_inventory-3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_inventory-3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 112ef112be8f3435c6b6a09dce6bbfa0da3c52249cf5dec9ad5e6af81e0edb51
MD5 77c1c8079c43f2cdc2208507a98ec58d
BLAKE2b-256 363f1ced598de45d3c40b1f4c3a51de9362abdcf5c44e5479636051fefb38a21

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_inventory-3.1-py3-none-any.whl:

Publisher: release.yml on cfpb/wagtail-inventory

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page