mozilla
/
taar-api-lite
зеркало из https://github.com/mozilla/taar-api-lite.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
TAAR-lite webservice
107 коммитов 10 Ветки 6 Теги 206 KiB
Python 70.5%
Shell 17.8%
Dockerfile 6.5%
Makefile 5.2%
Перейти к файлу
Victor Ng 3409113816 bumped srgutil and taar-lite versions to get updated logging 2018-04-23 17:11:32 -04:00
.circleci Combine build and deploy into one job 2018-04-19 12:26:09 -04:00
bin Remove email from deploy script 2018-04-19 12:41:41 -04:00
taar_api remove logging patch 2018-04-23 11:01:16 -04:00
tests Added an enforcement that results are limited to 4 items 2018-04-23 10:52:08 -04:00
.coveragerc Initial commit 2017-08-03 16:42:33 +01:00
.dockerignore Initial commit 2017-08-03 16:42:33 +01:00
.gitignore Added more artifacts during build to gitignore 2018-03-20 14:21:20 -05:00
Dockerfile Force pip to be version 9 and use python3.6 for tox 2018-04-17 15:07:26 +02:00
LICENSE Initial commit 2017-08-03 16:42:33 +01:00
Makefile reworked hashin freezing to use a shellscript 2018-04-09 23:43:00 +02:00
README.md minor fixes to README for clarity and swapped out references to TAAR for 2018-04-17 15:28:10 +02:00
contribute.json Update contribute.json 2017-08-15 10:38:36 -04:00
docker-compose.yml Added redis service to docker-compose 2018-04-12 17:38:09 +02:00
requirements.txt bumped srgutil and taar-lite versions to get updated logging 2018-04-23 17:11:32 -04:00
setup.cfg Replaced Django implementation with Flask implementation 2018-03-20 14:21:20 -05:00
setup.py updated description in setup.py 2018-04-09 17:09:02 +02:00
tox.ini Force pip to be version 9 and use python3.6 for tox 2018-04-17 15:07:26 +02:00

README.md

TAAR API-lite

CircleCI codecov

Instructions for development

  1. Make sure you have docker and docker-compose
  2. make up

Instructions for deployment

The target environment for this project follows the 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

Updating Taar

The core of taar-service lives in the mozilla-taarlite python package. These are the steps required to deploy a new version of mozilla-taarlite on taar-api-lite using hashin:

From the root of the repository:

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.