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.0, 2.2

  • Wagtail 1.13, 2.3, 2.8

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

Uploaded Source

Built Distribution

wagtail_inventory-1.0-py3-none-any.whl (20.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: wagtail-inventory-1.0.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9

File hashes

Hashes for wagtail-inventory-1.0.tar.gz
Algorithm Hash digest
SHA256 6d8f5fc29c40d8559ec339b278ec3f9563ce9b3d570a5edad954cd1d1ae7a460
MD5 da6560c218c9356def56e94f1a58deec
BLAKE2b-256 e23fae2a3704ec6417fc42d1d999bccb1ecbce90f8417118e26e651a613efc25

See more details on using hashes here.

Provenance

File details

Details for the file wagtail_inventory-1.0-py3-none-any.whl.

File metadata

  • Download URL: wagtail_inventory-1.0-py3-none-any.whl
  • Upload date:
  • Size: 20.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.6.9

File hashes

Hashes for wagtail_inventory-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 17ce404d136ae5fb53c00e1010c69cb3881f00e07a64d427c6b2387395e93ed7
MD5 38728a3f75bde62082ecd0f2c0813fcd
BLAKE2b-256 85d6c252a57a1da91f02bae56bda22858ae30ec3c33689b082f81b18fb779f79

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