Features

The indexr.buildr package is capable of constructing an inverted index.

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

Setup

This package can be installed using pip:

pip install indexr

Examples

In this example, an indexer is constructed for 3 files. The example uses the following 3 files:

0.txt:

The 0th document.

1.txt:

The 1st document.

2.txt:

The 2nd document. Some words: repeat, repeat, repeat.

The following code sample can be found in the demo directory (demo/buildr.py).

# Build the index
index = build_index(files, 'index', force_rebuild=True, indexer=SPIMI(show_progress=True))

# Try to find the word "1st"
print('All found occurrences of "1st":')
print(index.find('1st', frequencies=True), "\n")

# Try to find the word "The"
print('All found occurrences of "The":')
print(index.find('The', frequencies=True), "\n")

# Try to find the word "repeat"
print('All found occurrences of "repeat":')
print(index.find('repeat', frequencies=True), "\n")

It gives the following output:

>>> All found occurrences of "1st":
>>> {'1.txt': 1}
>>>
>>> All found occurrences of "The":
>>> {'0.txt': 1, '1.txt': 1, '2.txt': 1}
>>>
>>> All found occurrences of "repeat":
>>> {'2.txt': 3}

So indeed, it finds 1 occurrence of “1st”, 3 occurrences of “The” (1 occurrence in each file) and 3 occurrences of “repeat” (3 occurrences in one file).

Documentation

https://indexr.readthedocs.org

Credits

Tools used in rendering this package:

• Cookiecutter

• cookiecutter-pypackage

History

0.1.12 (2015-12-05)

• Added SPIMI algorithm and benchmarking script.

0.1.0 (2015-12-04)

• First release on PyPI.