# taar-api-lite

**Repository Path**: mirrors_mozilla/taar-api-lite

## Basic Information

- **Project Name**: taar-api-lite
- **Description**: TAAR-lite webservice
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TAAR API-lite

[![CircleCI](https://circleci.com/gh/mozilla/taar-api-lite.svg?style=shield)](https://circleci.com/gh/mozilla/taar-api-lite)
[![codecov](https://codecov.io/gh/mozilla/taar-api-lite/branch/master/graph/badge.svg)](https://codecov.io/gh/mozilla/taar-api-lite)


## Instructions for development

The only special thing you will need to do is to export your AWS keys
as enviroment variables to run the dev server. The docker-compose.yml
file specifies two keys `AWS_SECRET_ACCESS_KEY` and
`AWS_ACCESS_KEY_ID`.  These keys are required to access the S3 buckets
which host the data models used by TAARlite.

0. Make sure you have [docker](https://docker.io) and [docker-compose](https://github.com/docker/compose)
1. export AWS_SECRET_ACCESS_KEY=<your secret access key here>
2. export AWS_ACCESS_KEY_ID=<your access key here>
3. make up

## Instructions for deployment

The target environment for this project follows the [dockerflow](https://github.com/mozilla-services/Dockerflow) conventions.
In order to run it correctly, a number of environment variables needs to be set up.
The full list of variables can be found in the web section of the docker-compose.yml file.
From a services standpoint, this project requires:
 - an optional Redis cache service, defined by CACHE_URL
 - redis cache expiry in seconds defined by TAAR_CACHE_EXPIRY

### Updating Taar

The core of taar-service lives in the [mozilla-taarlite](https://pypi.python.org/pypi/mozilla-taarlite) python package.
These are the steps required to deploy a new version of mozilla-taarlite on taar-api-lite using [hashin](https://pypi.python.org/pypi/hashin):

From the root of the repository:

```bash
hashin mozilla-taarlite==<major>.<minor>.<patch>
```
Then open a pull request with the changes to requirements.txt. Once
it's merged to master, the service will automatically update.


## Web API


The dev service is hosted at: htps://taar.dev.mozaws.net

You must include a single GUID as the last segment of a URL encoded
path.

The TAARlite service currently exposes a single URL that can be called
with HTTP GET on the URL path : 

```
    /taarlite/api/v1/addon_recommendations/<your_guid_here>/
```

A sample invocation for the GUID `{some_addon_guid}` using curl would look like this:

```bash
curl https://taar.dev.mozaws.net/taarlite/api/v1/addon_recommendations/%7Bsome_addon_guid%7D/
```

You should get JSON output that appears in this format: 

```json
{"results": ["guid1", "guid2", "guid3", "guid4"]}
```

You may specify an optional normalization mode by passing in a CGI
argument `normalize` using one of the following choices:

* rownorm_sum
* row_count
* row_sum

Generally - you should get the best results using `rownorm_sum`.

Passing in an invalid normalization type will yield an empty `results`
list.

Example :

```bash
curl http://localhost:8000/taarlite/api/v1/addon_recommendations/%7Bsome_addon_guid%7D/?normalize=rownorm_sum
```