iterative-telemetry

Iterative Telemetry

|PyPI| |Status| |Python Version| |License|

|Tests| |Codecov| |pre-commit| |Black|

.. |PyPI| image:: https://img.shields.io/pypi/v/iterative-telemetry.svg :target: https://pypi.org/project/iterative-telemetry/ :alt: PyPI .. |Status| image:: https://img.shields.io/pypi/status/iterative-telemetry.svg :target: https://pypi.org/project/iterative-telemetry/ :alt: Status .. |Python Version| image:: https://img.shields.io/pypi/pyversions/iterative-telemetry :target: https://pypi.org/project/iterative-telemetry :alt: Python Version .. |License| image:: https://img.shields.io/pypi/l/iterative-telemetry :target: https://opensource.org/licenses/Apache-2.0 :alt: License .. |Tests| image:: https://github.com/iterative/iterative-telemetry/workflows/Tests/badge.svg :target: https://github.com/iterative/iterative-telemetry/actions?workflow=Tests :alt: Tests .. |Codecov| image:: https://codecov.io/gh/iterative/iterative-telemetry/branch/main/graph/badge.svg :target: https://app.codecov.io/gh/iterative/iterative-telemetry :alt: Codecov .. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white :target: https://github.com/pre-commit/pre-commit :alt: pre-commit .. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/psf/black :alt: Black

Features

• can be disabled in all tools by setting ITERATIVE_DO_NOT_TRACK=1 env var
• single anonymised user_id across all iterative projects
• collects minimal amount of anonymised data. For example:

.. code:: python

{
    "tool_name": "dvc",
    "tool_version": "2.14.0",
    "user_id": "e798d2e2-8941-4f24-a868-3adcbf6467df",
    "os_name": "mac",
    "os_version": "12.3",
}

Requirements

• TODO

Installation

You can install Iterative Telemetry via pip_ from PyPI_:

.. code:: console

$ pip install iterative-telemetry

Usage

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide_.

License

Distributed under the terms of the Apache 2.0 license_, Iterative Telemetry is free and open source software.

Issues

If you encounter any problems, please file an issue_ along with a detailed description.

.. _Apache 2.0 license: https://opensource.org/licenses/Apache-2.0 .. _PyPI: https://pypi.org/ .. _file an issue: https://github.com/iterative/iterative-telemetry/issues .. _pip: https://pip.pypa.io/ .. github-only .. _Contributor Guide: CONTRIBUTING.rst