Metadata-Version: 2.1
Name: ckanext-resource-indexer
Version: 0.1.0
Summary: UNKNOWN
Home-page: https://github.com/DataShades/ckanext-resource_indexer
Author: 
Author-email: 
License: AGPL
Description: .. image:: https://github.com/DataShades/ckanext-resource_indexer/actions/workflows/test.yml/badge.svg
            :target: https://github.com/DataShades/ckanext-resource_indexer/actions/workflows/test.yml
        
        ========================
        ckanext-resource_indexer
        ========================
        
        Index content of resources in addition to metadata.
        
        Important
        ~~~~~~~~~
        
        master branch of this repository is unstable. Always install **ckanext-resource-indexer** using pip(``pip install ckanext-resource-indexer``) unless you are going to change extension's source code for your need.
        
        ---------------
        Config Settings
        ---------------
        
        ::
        
            # The size treshold(MB) for remote resources
            # (optional, default: 4).
            ckanext.resource_indexer.max_remote_size = 4
        
            # Make an attempt to index remote files(fetch into tmp folder
            # using URL)
            # (optional, default: false).
            ckanext.resource_indexer.allow_remote = 1
        
            # List of lowercased resource formats that should be
            # indexed. Currently only `pdf` and `txt` supported
            # (optional, default: None)
            ckanext.resource_indexer.indexable_formats = txt pdf
        
            # Field containing data extacted from the file in addition to the
            # general `text` field
            # (optional, default: None)
            ckanext.resoruce_indexer.index_field = extras_res_attachment
        
            # Boost matches by resource's content. Set values greater that 1 in order #
            # to promote such matches and value between 0 and 1 in order to put such #
            # matches further in search results. Works only when using custom index
            # field(ckanext.resoruce_indexer.index_field)
            # (optional, default: 1)
            ckanext.resoruce_indexer.search_boost = 0.5
        
        ------------------------
        Development Installation
        ------------------------
        
        To install ckanext-resource_indexer for development, activate your CKAN virtualenv and
        do::
        
            git clone https://github.com/DataShades/ckanext-resource_indexer.git
            cd ckanext-resource_indexer
            python setup.py develop
        
        Add ``resource_indexer`` (and optionaly ``pdf_resource_indexer`` or
        ``plain_resource_indexer``) to the ``ckan.plugins`` setting in your
        CKAN config file (by default the config file is located at
        ``/etc/ckan/default/production.ini``).
        
        -----------------
        Running the Tests
        -----------------
        
        To run the tests, do::
        
          pytest --ckan-ini test.ini
        
        ---------
        AWS Linux
        ---------
        
        ::
        
           sudo yum install -y pulseaudio-libs-devel python-devel libxml2-devel libxslt-devel poppler poppler-utils poppler-cpp-devel
        
Keywords: CKAN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Provides-Extra: pdf
Provides-Extra: all
