Skip to content
A repository of various activedata queries and recipes
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Remove unused docs May 15, 2019
extra Add script to automatically generate recipe documentation May 10, 2019
recipes Mark 'tests_in_duration' as broken Jun 12, 2019
test Remove 'adr' related code (it has moved to github.com/mozilla/adr) May 15, 2019
.editorconfig
.gitignore Make Configuration() object a singleton and stop passing it around Mar 28, 2019
.travis.yml Fix TravisCI Mar 21, 2019
CODE_OF_CONDUCT.md
LICENSE Initial commit Sep 21, 2017
README.md
doclint Move queries/recipes to top-level Mar 28, 2019
poetry.lock Depend on adr ^0.16.2 Jun 12, 2019
pyproject.toml Depend on adr ^0.16.2 Jun 12, 2019
requirements.readthedocs.txt Add requirements.txt for readthedocs May 10, 2019
tox.ini Remove 'doclint' deps (they no longer appear necessary) Jun 12, 2019

README.md

Build Status PyPI version

ActiveData Recipes

This is a repository of various ActiveData recipes. A recipe is a small snippet that runs one or more ActiveData queries and returns the output. Queries can sometimes be modified by command line arguments and output can sometimes be post-processed.

Each recipe should try to answer a single question.

Installation

First install poetry, then run:

$ git clone https://github.com/mozilla/active-data-recipes
$ cd active-data-recipes
$ poetry install

You will need Python 3.6 or higher.

Usage

The poetry install command will create a virtualenv with all of the required dependencies installed. You can use poetry run <cmd> to run a single command within the virtualenv context. Or you can use poetry shell to spawn a new shell with the virtualenv activated. The commands below assume you have run the latter.

Run:

$ adr <recipe> <options>

For a list of recipes:

$ adr list

For recipe specific options see:

$ adr <recipe> -- --help

To serve the web app locally:

$ adr-app

Recipes

See the recipe documentation for more information on which recipes are available and how to run them.

Development

To contribute to active-data-recipes first follow the installation steps above. You can run tests with:

$ poetry run tox

Or:

$ poetry shell
$ tox
You can’t perform that action at this time.