active-data-recipes

A repository of various ActiveData recipes. A recipe is a small snippet that runs one or more active data 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.

Software requirements

• You will need Python 3.6 or higher to run the program.

Installation

$ pip install adr

Usage

Run:

$ adr <recipe> <options>

For a list of recipes:

$ adr --list

For recipe specific options see:

$ adr <recipe> -- --help

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 install poetry, then run:

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

Now you can use poetry run to perform various development commands:

# run adr
$ poetry run adr <recipe>

# run webapp
$ poetry run adr-app

# run tests
$ poetry run tox

Alternatively activate the poetry shell ahead of time:

$ poetry shell

# run adr
$ adr <recipe>

# run app
$ adr-app

# run tests
$ tox