Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cfpb/wagtail-inventory
Search Wagtail pages by the StreamField blocks they contain
https://github.com/cfpb/wagtail-inventory
django hacktoberfest wagtail
Last synced: 7 days ago
JSON representation
Search Wagtail pages by the StreamField blocks they contain
- Host: GitHub
- URL: https://github.com/cfpb/wagtail-inventory
- Owner: cfpb
- License: cc0-1.0
- Created: 2017-03-23T17:11:12.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-09-23T17:20:38.000Z (about 2 months ago)
- Last Synced: 2024-10-28T23:54:40.995Z (12 days ago)
- Topics: django, hacktoberfest, wagtail
- Language: Python
- Homepage:
- Size: 163 KB
- Stars: 59
- Watchers: 27
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-wagtail - wagtail-inventory - Search Wagtail pages by the StreamField blocks they contain. (Apps / StreamField)
README
.. image:: https://github.com/cfpb/wagtail-inventory/workflows/test/badge.svg
:alt: Build Status
:target: https://github.com/cfpb/wagtail-inventory/actions/workflows/test.yml
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:
.. code-block:: bash
$ pip install wagtail-inventory
Add `wagtailinventory`` as an installed app in your Django settings:
.. code-block:: python
# in settings.py
INSTALLED_APPS = (
...
'wagtailinventory',
...
)
Run migrations to create required database tables:
.. code-block:: bash
$ manage.py migrate wagtailinventory
Run a management command to initialize database tables with current pages:
.. code-block:: bash
$ 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 `_:
.. code-block:: bash
$ tox
To run the test app interactively, run:
.. code-block:: bash
$ tox -e interactive
Now you can visit http://localhost:8000/admin/ in a browser and log in with ``admin`` / ``changeme``.
Open source licensing info
--------------------------
#. `TERMS `_
#. `LICENSE `_
#. `CFPB Source Code Policy `_