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

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-2.3.tar.gz
  • Upload date:
  • Size: 13.7 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.3.tar.gz
Algorithm Hash digest
SHA256 d557ff02a4c8ab1941b17a83298ed3e85296949e793cb462ec5308cd9609fe6e
MD5 55eb21f87dc0e7a8bd234146e152d073
BLAKE2b-256 863819564765c38b008e3e1ff20e836d474b5149b23b277048f18920d01cdee6

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for wagtail_inventory-2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b779fc9311ad532404fc6686c466d87dd2b313d543c7f7d76e6b77d3a9fd2bc9
MD5 e0dc91927ae8aaa08ec519689ba6a37d
BLAKE2b-256 89bcf8f3ad0001ce7790ded2d3fb743bcc76c17f0f790f9977e09c1c6ce689b8

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