Skip to main content

Lookup Wagtail pages by block content

Project description

Build Status Coverage 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 Settings menu 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

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

Compatibility

This code has been tested for compatibility with:

  • Python 3.6+

  • Django 3.2 (LTS), Django 4.0 (Current)

  • Wagtail 2.15 (LTS), Wagtail 2.16 (Current)

It should be compatible with all intermediate versions, as well. If you find that it is not, please file an issue.

Testing

Run unit tests with tox to test against select supported package combinations.

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

Uploaded Source

Built Distribution

wagtail_inventory-1.5-py2.py3-none-any.whl (21.4 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-1.5.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.8.12

File hashes

Hashes for wagtail-inventory-1.5.tar.gz
Algorithm Hash digest
SHA256 82ca3cb93a977f52406a6a3c8be818aa87d8cff49dafbd423fab801e8ab1696d
MD5 50cc4eda69d3055b25a8849097e24f4d
BLAKE2b-256 4a7df38e7a07da3bdd74c845a316354bf4afb96fec619c6c88f8a6a44aad6e6a

See more details on using hashes here.

Provenance

File details

Details for the file wagtail_inventory-1.5-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wagtail_inventory-1.5-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 ea324fb4918319e5de33f3d61a2c1fe52bb3719a096d35612b6fcb1b74c86347
MD5 80dddfef6d0c6c763a02f78442985cfc
BLAKE2b-256 ae4119915fe28b3312edbafe31f6cc86a22a6619e7b9edf5d187aede8b3b5ecb

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