glean_parser

Tools for parsing the metadata for Mozilla's glean telemetry SDK

Перейти к файлу

Michael Droettboom 8149ed364d Use pre-built detekt		2019-10-22 14:56:16 -04:00
.circleci	Fix dependency installation	2019-10-22 12:00:02 -04:00
.github	Add instructions to use changelog, and backfill changelog	2019-07-30 11:04:33 -04:00
docs	Enable parsing of the `gecko_datapoint` attribute in metrics.yaml (#75 )	2019-07-22 15:15:41 +02:00
glean_parser	Run detekt over generated Kotlin code in unit tests	2019-10-22 11:46:57 -04:00
tests	Use pre-built detekt	2019-10-22 14:56:16 -04:00
.editorconfig	Initial commit from cookiecutter	2018-10-15 09:48:45 -04:00
.flake8	Add .flake8 configuration	2019-08-22 15:39:34 -04:00
.gitignore	Use pre-built detekt	2019-10-22 14:56:16 -04:00
.swiftlint.yml	Lint generated swift files (if swiftlint is available)	2019-09-16 14:25:38 +02:00
AUTHORS.rst	Add Travis Long to AUTHORS	2019-03-29 15:28:01 -04:00
CODE_OF_CONDUCT.md	Add Mozilla Code of Conduct file (#52 )	2019-04-01 09:30:27 +02:00
CONTRIBUTING.rst	Run detekt over generated Kotlin code in unit tests	2019-10-22 11:46:57 -04:00
HISTORY.rst	Update HISTORY.rst	2019-10-22 17:01:55 +02:00
LICENSE	Initial commit from cookiecutter	2018-10-15 09:48:45 -04:00
MANIFEST.in	Fix typo	2018-10-22 15:02:47 -04:00
Makefile	Use pre-built detekt	2019-10-22 14:56:16 -04:00
README.rst	1544276: glean -> Glean	2019-04-29 13:59:19 -04:00
requirements_dev.txt	MAINT: Use black to format code	2019-08-22 15:29:17 -04:00
setup.cfg	Use setuptools-scm instead of bumpversion	2019-07-22 08:29:57 -04:00
setup.py	MAINT: Upgrade dependencies	2019-08-22 11:02:31 -04:00
tox.ini	Basic customization after cookiecutter	2018-10-15 10:00:16 -04:00

README.rst

============
Glean Parser
============

Parser tools for Mozilla's Glean telemetry.

Features
--------

Parses the ``metrics.yaml`` files for the Glean telemetry SDK and produces
output for various integrations.

Documentation
-------------

The full documentation is available `here <https://mozilla.github.io/glean_parser/>`__.

Requirements
------------

- Python 3.7 (or later)

The following library requirements are installed automatically when glean_parser
is installed by `pip`.

- appdirs
- Click
- diskcache
- inflection
- Jinja2
- jsonschema
- PyYAML

Usage
-----

.. code-block:: console

  $ glean_parser --help

Read in `metrics.yaml`, translate to kotlin format, and output to `output_dir`:

.. code-block:: console

  $ glean_parser translate -o output_dir -f kotlin metrics.yaml

Check a Glean ping against the ping schema:

.. code-block:: console

  $ glean_parser check < ping.json