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 2.2 (LTS), 3.1 (current)

  • Wagtail 2.7 (LTS), 2.10 (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.2.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

wagtail_inventory-1.2-py2.py3-none-any.whl (19.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-1.2.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for wagtail-inventory-1.2.tar.gz
Algorithm Hash digest
SHA256 2728ca57bd68baae0da50dafa923586c489cef65cfc5ac5a25cc147eedf7ce92
MD5 b6fab8714ca628996658b53dd957c5f5
BLAKE2b-256 5e440600867271cb3f9bac70cbaf4fd48e355d19b78c3fe8b26a321782167c7a

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: wagtail_inventory-1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.0 CPython/3.8.6

File hashes

Hashes for wagtail_inventory-1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 815ba1bb96216f12bb411bd387d2a6cf991fee204af9e3dfcd40ad77202f58dc
MD5 8b7206d8f57b838c8ebbc4ba32ac17ce
BLAKE2b-256 d27997dabb166ea8ffb9c85a6b07a20ae59ceb7b2dc5cdd07e758bafaef824a8

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