Skip to main content

Lookup Wagtail 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 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, 3.8

  • Django 1.11, 2.2

  • Wagtail 2.3, 2.9, 2.10

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

Uploaded Source

Built Distribution

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

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-1.1.1.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for wagtail-inventory-1.1.1.tar.gz
Algorithm Hash digest
SHA256 e332fb18fa5366f0c0acc6e5d58aa1740ab6ede9b24f414e7223f85e2dbbea64
MD5 0c58e0e6ef16351ecf14ed56f3275ee2
BLAKE2b-256 daf0002b0516fd4431e35e5fb00a02d228a594e05b922f4b52ac8d14451c2d15

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: wagtail_inventory-1.1.1-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.5.0.1 requests/2.24.0 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5

File hashes

Hashes for wagtail_inventory-1.1.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e0a48dea01c5c103257d1ea07e97dfcc98bac0cd806451cf7001452337ed7c87
MD5 2952de72a1c0dee68dce5bb8f5c7ce1f
BLAKE2b-256 cee2ebf1b011059b2dfe64c45a12d7bf14c0d9424a1e9515fb265d28b72aaa93

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