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

You should now be able to search your pages in the Wagtail admin site, under Reports > Block Inventory.

Compatibility

This code has been tested for compatibility with:

  • Python 3.8+

  • Django 3.2 (LTS), 4.1

  • Wagtail 3.0, 4.1 (LTS), 4.2

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

Uploaded Source

Built Distribution

wagtail_inventory-2.0.0-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for wagtail-inventory-2.0.0.tar.gz
Algorithm Hash digest
SHA256 1fc504ebdbd8915bb5f7fad3ef9c08d30c020257408318cf157551357494c421
MD5 aba28310fff05625f79c054112caf98d
BLAKE2b-256 6ff6c29adb269309b4143a75cf32cd5e874d8050120fd08a92df46a9d84211a4

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for wagtail_inventory-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eae24b5137df6e62ee9a6137901a3ec5e0f8557716b87923e58dda6917a8b26e
MD5 755e390506b1443a06bce7a80849ce9b
BLAKE2b-256 bb6fb0e4e1fb26ec98d2bc701580aa486a62681dfe592fffc1bbef5e831c6ab7

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