Wagtail report to filter pages by block content

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for cfpb from gravatar.com cfpb Avatar for chosak from gravatar.com chosak

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication, Public Domain (CC0)
  • Author: CFPB
  • Requires: Python >=3.8
Classifiers

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 report 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

This will also install django-autocomplete-light.

Add dal, dal_select2, and wagtailinventory as installed apps in your Django settings:

# in settings.py
INSTALLED_APPS = (
    ...
    'dal',
    'dal_select2',
    '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 Reports > Block Inventory.

Compatibility

This code has been tested for compatibility with:

  • Python 3.8+

  • Django 3.2 (LTS), 4.1

  • Wagtail 3.0, 4.1 (LTS), 4.2

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for cfpb from gravatar.com cfpb Avatar for chosak from gravatar.com chosak

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication, Public Domain (CC0)
  • Author: CFPB
  • Requires: Python >=3.8
Classifiers

Release history Release notifications | RSS feed

3.0.1

3.0

2.6

2.5

2.4

2.3

2.2

This version

2.1

2.0.0

1.7.0

1.6

1.5

1.4.1

1.4

1.3.1

1.3

1.2

1.1.1

1.1

1.0

0.8

0.7

0.7rc2 pre-release

0.7rc1 pre-release

0.6

0.5.1

0.5

0.4.2

0.4.1

0.4

0.3

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

Uploaded Source

Built Distribution

wagtail_inventory-2.1-py3-none-any.whl (19.3 kB view hashes)

Uploaded Python 3

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