Wagtail report to filter pages by block content

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for cfpb from gravatar.com cfpb Avatar for chosak from gravatar.com chosak Avatar for willbarton from gravatar.com willbarton

Unverified details

These details have not been verified by PyPI
Meta
  • License: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication, Public Domain (CC0)
  • Author: CFPB
  • Requires: Python >=3.10
  • Provides-Extra: testing
Classifiers
Report project as malware

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

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

Admin users should now be able to search pages in the Wagtail admin site, under Reports > Block Inventory.

Other user groups may be granted access to the report by giving them the “Can view” “Page block” permission in Wagtail Group settings.

Compatibility

This code has been tested for compatibility with:

  • Python 3.10, 3.12, 3.13

  • Django 4.2 (LTS), 5.1

  • Wagtail 6.2, 6.3 (LTS), 6.4

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
Project links
GitHub Statistics
Maintainers
Avatar for cfpb from gravatar.com cfpb Avatar for chosak from gravatar.com chosak Avatar for willbarton from gravatar.com willbarton

Unverified details

These details have not been verified by PyPI
Meta
  • License: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication, Public Domain (CC0)
  • Author: CFPB
  • Requires: Python >=3.10
  • Provides-Extra: testing
Classifiers

Release history Release notifications | RSS feed

This version

3.2

3.1

3.0.1

3.0

2.6

2.5

2.4

2.3

2.2

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wagtail_inventory-3.2-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file wagtail_inventory-3.2.tar.gz.

File metadata

  • Download URL: wagtail_inventory-3.2.tar.gz
  • Upload date:
  • Size: 20.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wagtail_inventory-3.2.tar.gz
Algorithm Hash digest
SHA256 989b05928d1283db155d9d47732053829f568cffa7f5925087db96b88acca890
MD5 084ca77361f429569b416a38d08e9382
BLAKE2b-256 ea3a26eff70575513f66a77479992577803f778cfc49d0eb7d724c1bf8b31b91

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_inventory-3.2.tar.gz:

Publisher: release.yml on cfpb/wagtail-inventory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

File hashes

Hashes for wagtail_inventory-3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 12e01b79e4d7adb8e8c425b7ebfad6b3c0873dfb40f43a31ab2258fb2ef9276a
MD5 54a8bb020f3255cd5eb2012f0671be13
BLAKE2b-256 d4d443e1905363785a351662e408be4132a15f4c874b934c0e01827bc7da0329

See more details on using hashes here.

Provenance

The following attestation bundles were made for wagtail_inventory-3.2-py3-none-any.whl:

Publisher: release.yml on cfpb/wagtail-inventory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page