vitals-scraper
v1.0.7
Published
![npm](https://img.shields.io/npm/v/vitals-scraper.svg) [![Build Status](https://travis-ci.org/commercetest/vitals-scraper.svg?branch=master)](https://travis-ci.org/commercetest/vitals-scraper) [![codecov](https://codecov.io/gh/commercetest/vitals-scraper
Downloads
20
Readme
Vitals Scraper
🤖 A simple Android Vitals scraper
Usage
# Install
npm i -g vitals-scraper
# Run
vitals-scraper --accountId=XXX --packageName=XXX --mode=overview
The program can run in two modes:
- to obtain an overview of various data about one or more of the apps on your Google Play developer account. The program outputs a csv file of summary data together with several screenshots of various reports per app you specify.
- to download crash data for one or more of your apps on your Google Play developer account. for the Java packagenames specified in the
--packageName
command-line parameter.
Options
--accountId
required--packageName
required (*
would download data for all the apps on the account)--days
(default7
)--mode
(deafultcrashes
)--numExceptions=2
(defaultall
)--format
(default:csv
)--outDir
(default:./
)--parallel
(default:1
)--verbose
(default:false
)
Examples of command-lines
npm run start:dev -- --accountId=<add-your-accountId> --mode=overview
Contributing
Running
VSCode Debugger
If you use VSCode, there is a pre-configured launch config: .vscode/launch.json
. Note: this contains several examples of how to run the program so it may be worth reading even if you are not using VSCode.
This is preferable as no compilation step is required, and breakpoints can be used.
CLI
CLI typescript execution is provided by the start:dev
npm script in package.json
. When executing with these scripts, --
is required to tell bash to pass on the arguments.
E.g.
> npm run start:dev -- --accountId=XXX --packageName=XXX --format=json
Data Playground
There is a data playground.
If you have VSCode installed, there is a preset in .vscode/launch.json
which allows you to debug your data processing code.
Otherwise, you can call it form the command line like so:
> npm run playground -- --data=./android-crash-clusters_1557226424411.json
Building
> npm install
> npm run build
Testing
> npm t
Installing modified version
> npm run build && npm i -g .