Tools for parsing the metadata for Mozilla's glean telemetry SDK
Перейти к файлу
Michael Droettboom 4066a9da6e Minor doc improvements to get the docs to build 2018-11-20 18:03:35 -05:00
.github Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
docs Minor doc improvements to get the docs to build 2018-11-20 18:03:35 -05:00
glean_parser Minor doc improvements to get the docs to build 2018-11-20 18:03:35 -05:00
tests Enforce that event lifetime is ping 2018-11-13 13:04:30 -05:00
.editorconfig Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
.gitignore Minor doc improvements to get the docs to build 2018-11-20 18:03:35 -05:00
.travis.yml Make sure Kotlin output is ktlint-compliant 2018-10-26 15:38:38 -04:00
AUTHORS.rst Basic customization after cookiecutter 2018-10-15 10:00:16 -04:00
CONTRIBUTING.rst Basic customization after cookiecutter 2018-10-15 10:00:16 -04:00
HISTORY.rst Initial commit from cookiecutter 2018-10-15 09:48:45 -04: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 Python 3 linting for flake8 2018-10-22 15:02:47 -04:00
README.rst Fix code-block formatting in README.rst (#2) 2018-10-25 10:35:29 +02:00
requirements_dev.txt Initial commit from cookiecutter 2018-10-15 09:48:45 -04:00
setup.cfg Bump version: 0.5.0 → 0.6.0 2018-11-02 08:33:03 -04:00
setup.py Bump version: 0.5.0 → 0.6.0 2018-11-02 08:33:03 -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.

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

- Python 3.7 (or later)

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

- Click
- PyYAML
- jsonschema
- inflection
- Jinja2

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

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage