wagtail-inventory

Wagtail report to filter pages by block content

These details have been verified by PyPI

Project links

GitHub Statistics

Maintainers

cfpb chosak

These details have not been verified by PyPI

Project description

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.8, 3.12
Django 4.2 (LTS), 5.0
Wagtail 6.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

Project details

These details have been verified by PyPI

Project links

GitHub Statistics

Maintainers

cfpb chosak

These details have not been verified by PyPI

Release history Release notifications | RSS feed

This version

3.0.1

Sep 23, 2024

3.0

Sep 23, 2024

2.6

Feb 27, 2024

2.5

Nov 17, 2023

2.4

Oct 6, 2023

2.3

Oct 5, 2023

2.2

Jul 31, 2023

2.1

Jul 24, 2023

2.0.0

Mar 9, 2023

1.7.0

Mar 3, 2023

1.6

Nov 10, 2022

1.5

May 18, 2022

1.4.1

Mar 3, 2022

1.4

Feb 28, 2022

1.3.1

Mar 3, 2022

1.3

May 3, 2021

1.2

Dec 4, 2020

1.1.1

Aug 11, 2020

1.1

Jun 19, 2020

1.0

Feb 24, 2020

0.8

Nov 19, 2019

0.7

May 2, 2019

0.7rc2 pre-release

Apr 30, 2019

0.7rc1 pre-release

Apr 30, 2019

0.6

Jan 22, 2019

0.5.1

Sep 7, 2018

0.5

Jul 10, 2018

0.4.2

May 14, 2018

0.4.1

Mar 7, 2018

0.4

Oct 31, 2017

0.3

Sep 22, 2017

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

Uploaded Sep 23, 2024 Source

Built Distribution

wagtail_inventory-3.0.1-py3-none-any.whl (21.2 kB view details)

Uploaded Sep 23, 2024 Python 3

File details

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

File metadata

Download URL: wagtail_inventory-3.0.1.tar.gz
Upload date: Sep 23, 2024
Size: 20.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for wagtail_inventory-3.0.1.tar.gz
Algorithm	Hash digest
SHA256	`aa69076e778021afc650ca954cdbe34908266a07ae0d5d509f2acdfb133c526b`
MD5	`cbba4ceef5900689033ab211d532a34f`
BLAKE2b-256	`01f8fb68f2bf6fe058e8fd7f28af5118d01e083696a9edde54921dc5a6633cd7`

See more details on using hashes here.

Provenance

File details

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

File metadata

Download URL: wagtail_inventory-3.0.1-py3-none-any.whl
Upload date: Sep 23, 2024
Size: 21.2 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for wagtail_inventory-3.0.1-py3-none-any.whl
Algorithm	Hash digest
SHA256	`93dcbdbc65137880d3d5b8a2143cd63836e232ea8ca85ce4b37cde8c099b2f1f`
MD5	`cad69d5cb4b4292b763774f60eb2425b`
BLAKE2b-256	`93c012e1b7a5a0825f0106a0d7a5b98582ef26213985059881416f5d257cea86`