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

This will also install django-autocomplete-light.

Add dal, dal_select2, and wagtailinventory as installed apps in your Django settings:

# in settings.py
INSTALLED_APPS = (
    ...
    'dal',
    'dal_select2',
    '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+

  • Django 3.2 (LTS), 4.1, 4.2 (LTS)

  • Wagtail 3.0, 4.1 (LTS), 4.2, 5.0, 5.1

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-2.4.tar.gz (13.8 kB view details)

Uploaded Source

Built Distribution

wagtail_inventory-2.4-py3-none-any.whl (20.3 kB view details)

Uploaded Python 3

File details

Details for the file wagtail-inventory-2.4.tar.gz.

File metadata

  • Download URL: wagtail-inventory-2.4.tar.gz
  • Upload date:
  • Size: 13.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for wagtail-inventory-2.4.tar.gz
Algorithm Hash digest
SHA256 772a6e4d288a244ac9cbdc40b7ad24807f3f78b7fcd3c8485a86efb1f9bc8cc1
MD5 3804a2fae197a2c58a84972153fcc2df
BLAKE2b-256 7992427a49b4811e64239d278038e723f0610e226399fe83a0c2d2bd62d62301

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for wagtail_inventory-2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 921311cca3dbca149af9ac3b3ecd72d0ea1627bf197b2b27ff0595bf09b4f655
MD5 e159c119a44966347b95f95726e6aadc
BLAKE2b-256 6e2139ac6d7679bdf4cb321cd5cb2010b644ca12fec9292a8a44b86cb4329359

See more details on using hashes here.

Provenance

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