Metadata-Version: 2.1
Name: wagtail-inventory
Version: 1.4.1
Summary: Lookup Wagtail pages by block content
Home-page: https://github.com/cfpb/wagtail-inventory
Author: CFPB
Author-email: tech@cfpb.gov
License: CCO
Description: .. image:: https://github.com/cfpb/wagtail-inventory/workflows/test/badge.svg
          :alt: Build Status
          :target: https://travis-ci.org/cfpb/wagtail-inventory
        .. image:: https://coveralls.io/repos/github/cfpb/wagtail-sharing/badge.svg?branch=main
          :alt: Coverage Status
          :target: https://coveralls.io/github/cfpb/wagtail-sharing?branch=main
        
        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:
        
        .. 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
        
        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+
        * Django 3.2 (LTS)
        * Wagtail 2.15 (LTS), 2.16 (current)
        
        It should be compatible with all intermediate versions, as well.
        If you find that it is not, please `file an issue <https://github.com/cfpb/wagtail-inventory/issues/new>`_.
        
        Testing
        -------
        
        Run unit tests with ``tox`` to test against select supported package combinations.
        
        Open source licensing info
        --------------------------
        
        #. `TERMS <https://github.com/cfpb/wagtail-inventory/blob/main/TERMS.md>`_
        #. `LICENSE <https://github.com/cfpb/wagtail-inventory/blob/main/LICENSE>`_
        #. `CFPB Source Code Policy <https://github.com/cfpb/source-code-policy>`_
        
Platform: UNKNOWN
Classifier: Framework :: Django
Classifier: Framework :: Django :: 2.2
Classifier: Framework :: Django :: 3.1
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 2
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: License :: Public Domain
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.6
Provides-Extra: testing
