Metadata-Version: 2.0
Name: indexr
Version: 0.1.6
Summary: A general purpose indexer written in Python.
Home-page: https://github.com/kevin91nl/indexr
Author: Kevin Jacobs
Author-email: kevin91nl@gmail.com
License: ISCL
Keywords: indexr
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4

===============================
indexr
===============================

.. image:: https://img.shields.io/pypi/v/indexr.svg
        :target: https://pypi.python.org/pypi/indexr

.. image:: https://img.shields.io/travis/kevin91nl/indexr.svg
        :target: https://travis-ci.org/kevin91nl/indexr

.. image:: https://readthedocs.org/projects/indexr/badge/
        :target: https://readthedocs.org/projects/indexr/
        :alt: Documentation Status


A general purpose indexer written in Python. Licensed under the MIT license.

Features
--------
The :code:`indexr.buildr` package is capable of constructing an inverted index.

The :code:`indexr.utils` package contains utilities, such as a tokenization method for converting a text to tokens.

Setup
-----
This package can be installed using pip:

:code:`pip install indexr`

Examples
--------
The following code sample can be found in the demo directory.


.. code-block:: python

    # Get a demo file system
    files = get_demo_filesystem()

    # Build the index
    index = buildr(files, INDEX_PATH, force_rebuild=True, indexer=BSB(show_progress=True))

    # Find all files which contain the word "movie" and also the corresponding frequency
    print('All found occurrences of "movie":')
    print(index.find('movie', frequencies=True))


Documentation
-------------
https://indexr.readthedocs.org

Credits
-------

Tools used in rendering this package:

*  Cookiecutter_
*  `cookiecutter-pypackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage




History
-------

0.1.6 (2015-12-05)
---------------------

* Add submodules.

0.1.5 (2015-12-05)
---------------------

* Bugfix.

0.1.4 (2015-12-05)
---------------------

* Bugfix.

0.1.3 (2015-12-05)
---------------------

* Bugfix.

0.1.2 (2015-12-05)
---------------------

* Moved the BSB algorithm.

0.1.1 (2015-12-05)
---------------------

* Block sort-based indexing implemented.

0.1.0 (2015-12-04)
---------------------

* First release on PyPI.


