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

Uploaded Source

Built Distribution

wagtail_inventory-1.3-py2.py3-none-any.whl (20.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-1.3.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.9

File hashes

Hashes for wagtail-inventory-1.3.tar.gz
Algorithm Hash digest
SHA256 706f0d2d082f6e8a360e098055bc2ed89f4b4198b39c9f06eca5389b9205f646
MD5 b1a4e3cd0fd7f45bad50d3e9349f1f23
BLAKE2b-256 dc4effac70a765a6deedf256e7d90877d6e451926c7800d7b841ed6796d613e5

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: wagtail_inventory-1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.8.9

File hashes

Hashes for wagtail_inventory-1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0962d4b3a1fd59cd67ef5095366eee8781b35a622d61ebc7acd3b46e3d4a6736
MD5 3dd02150335ff9509dfaa92ba5c91488
BLAKE2b-256 8250a93d0393ed16a125f35a9ebc27c49d15763d5614dc7b6c958e66ba34d699

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