dorey/kpi

KPI

https://travis-ci.org/kobotoolbox/kpi.svg?branch=develop](https://travis-ci.org/kobotoolbox/kpi)

Python Dependencies

Python dependencies are listed in requirements.in, which is then compiled to requirements.txt by https://github.com/nvie/pip-tools. You may use pip directly with requirements.txt, but *** using instead the pip-sync command provided by https://github.com/nvie/pip-tools. Do not add new dependencies directly to requirements.txt.

Downloading and compiling the translations

• Pull the submodule into the locale directory with git submodule update.
• Optionally configure transifex to pull the latest translations into the locale directory with tx pull --all
• Run python manage.py compilemessages to create .mo files from the .po files.
• To test out locales in the interface, double click "account actions" in the left navbar, use the dropdown to select a language, and refresh.

Searching assets and collections

Top-level (null-parent) assets and collections can be found by including parent= in the query string. For other searches, construct a string using the Whoosh query language and pass it in as the q parameter, e.g. /assets/?q=name:sanitation. Fields indexed by Whoosh are:

• name: a tokenized* representation of the name;
• name__exact: a space- and comma-escaped representation of the name, e.g. "Fun, Exciting Asset" would be indexed as "Fun--Exciting-Asset";
• owner__username: a tokenized* representation of the owner's username;
• owner__username__exact: a space- and comma-escaped representation of the owner's username;
• parent__name: a tokenized* representation of the parent object's name;
• parent__name__exact: a space- and comma-escaped representation of the parent object's name;
• parent__uid: the UID of the parent collection;
• ancestor__uid: a multi-value field containing the UIDs of all ancestor collections;
• tag: a multi-valued field holding space- and comma-escaped representations of each tag assigned to the object;
• asset_type (for assets only): a space- and comma-escaped representation of the asset's type string;
• text: the search "document," which is built by https://github.com/kobotoolbox/kpi/tree/master/kpi/templates/search/indexes/kpi.

When the q parameter contains a search term without a specified field, e.g. /collections/?q=health, that term is matched against the search "document" (the text field).

Searching tags

Construct a string using the Whoosh query language and pass it in as the q parameter, e.g. /tags/?q=asset_type:block. Fields indexed by Whoosh are:

• name__ngram: the tag's name decomposed into n-grams, e.g. ?q=name__ngram:cat would match tags named "dogs/cats" and "education";
• asset_type: a multi-value field containing the types (e.g. form, question, block) of all tagged assets;
• kind: a multi-value field containing "asset" when assets are tagged, "collection" when collections are tagged, or both;
• text: a tokenized* representation of the name, which serves as the search "document" (see note below).

When the q parameter contains a search term without a specified field, e.g. /tags/?q=health, that term is matched against the search "document" (the text field).

* Implemented by Haystack as https://github.com/django-haystack/django-haystack/blob/ad90028a22b4274b8df1f4698dd59ac0643f03d5/haystack/backends/whoosh_backend.py#L174. Unsuitable for exact matching.