CLI for generating experiment reports
Project description
mozreport
mozreport is a CLI tool that intends to help streamline the process of preparing an experiment report.
Using mozreport
$ mozreport --help
Usage: mozreport [OPTIONS] COMMAND [ARGS]...
Mozreport helps you write experiment reports.
The workflow looks like:
* `mozreport setup` the first time you use Mozreport
* `mozreport new` to declare a new experiment and generate an analysis
script
* `mozreport submit` to run an analysis script on Databricks
* `mozreport fetch` to download the result
* `mozreport report` to set up a report template
The local configuration directory is /Users/tsmith/Library/Application Support/mozreport.
What's a template?
A report template is any collection of code that operates on a file named summary.csv
in the current working directory,
and renders a report.
To add a template,
add a folder to the mozreport/templates
folder in this repository,
or the templates
folder inside your local configuration directory
(see the bottom of mozreport --help
).
You may wish to adopt the convention of including a script named build.py
that performs the necessary steps to render the report.
Hacking on mozreport
To run unit tests only:
tox -- -m "not integration"
To run all tests, including integration tests that hit our live Databricks account:
- Run
mozreport setup
once tox
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mozreport-18.12.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1573eba8004f93a55e2aa2c75dbad7901a015dcf04049941ad2a428ae32456f |
|
MD5 | ce4f183c16e250f65e4e195b5779e592 |
|
BLAKE2b-256 | 921e70f69046c82e9a04895b830cebe42781968f3ff9d611f7c6532b8917e589 |