Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

Utility for running ActiveData recipes

Project description

Build Status PyPI version PyPI version

adr

This is the runner for ActiveData recipes, it provides a command line interface and flask web app. ActiveData is a large data warehouse containing billions of records related to Mozilla's CI, version control, bug tracking and much more. An ActiveData "recipe" is a Python snippet that runs one or more queries against ActiveData, then performs some post-processing before returning the results.

Other than a handful of built-in recipes, this repo doesn't contain any actual recipes itself. Those live in project specific repositories that will typically depend on some version of this library. The recommended way to run a recipe is to follow the README of the desired recipe project rather than starting here.

Known Recipe Projects

Here are some of the known repositories containing ActiveData recipes:

  • active-data-recipes - Misc recipes that are mostly untriaged. Good for finding examples to copy from.

Installation

Although installing adr directly is not recommended, it is still supported:

$ pip install adr

You will need Python 3.6 or higher.

Usage

The adr binary will search for recipes that live under $CWD, so usually just changing directories to the repository containing recipes is the best way to ensure adr can discover them.

For a list of available recipes:

$ adr --list

To run a given recipe:

$ adr <recipe> <options>

For recipe specific options see:

$ adr <recipe> -- --help

Contributing

To contribute to adr first install poetry, then run:

$ git clone https://github.com/mozilla/adr
$ cd adr
$ 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
adr-0.16.2-py3-none-any.whl (33.8 kB) Copy SHA256 hash SHA256 Wheel py3
adr-0.16.2.tar.gz (28.0 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page