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.8+

  • Django 3.2 (LTS), 4.0, 4.1

  • Wagtail 2.15 (LTS), 3.0, 4.0, 4.1 (LTS)

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

Uploaded Source

Built Distribution

wagtail_inventory-1.6-py2.py3-none-any.whl (22.8 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-1.6.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.14

File hashes

Hashes for wagtail-inventory-1.6.tar.gz
Algorithm Hash digest
SHA256 4bb75ddc87d6abcaed4404b22977ee5b6f3a746c81a657f64b434e0cf2552de3
MD5 92ff60ab951b6415b0cfa4553f67964a
BLAKE2b-256 afbb962799cd0ce72146e107c4edfbaf4343493bd13373ba212a769f8eb1a53b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for wagtail_inventory-1.6-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 42d7845fd561a1b8c71b100b41f658351d5547a7653cfb689f2263df5ed5bcf3
MD5 9219a9aebb0d8ecbe0237dcf6cffd9c4
BLAKE2b-256 7a678fe49e0cc29f7f0c02d93941bbe3ab0858ae61e2f4fc7657c0a16c2f0933

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