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
Raw data
{
"_id": null,
"home_page": "https://github.com/iterative/telemetry-python",
"name": "iterative-telemetry",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "support@dvc.org",
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c7/c9/0c7ec6cfe9d0384bcfbab05f0570878f6859151ef3ce69a8762693b84c03/iterative_telemetry-0.0.9.tar.gz",
"platform": "any",
"description": "Iterative Telemetry\n===================\n\n|PyPI| |Status| |Python Version| |License|\n\n|Tests| |Codecov| |pre-commit| |Black|\n\n.. |PyPI| image:: https://img.shields.io/pypi/v/iterative-telemetry.svg\n :target: https://pypi.org/project/iterative-telemetry/\n :alt: PyPI\n.. |Status| image:: https://img.shields.io/pypi/status/iterative-telemetry.svg\n :target: https://pypi.org/project/iterative-telemetry/\n :alt: Status\n.. |Python Version| image:: https://img.shields.io/pypi/pyversions/iterative-telemetry\n :target: https://pypi.org/project/iterative-telemetry\n :alt: Python Version\n.. |License| image:: https://img.shields.io/pypi/l/iterative-telemetry\n :target: https://opensource.org/licenses/Apache-2.0\n :alt: License\n.. |Tests| image:: https://github.com/iterative/iterative-telemetry/workflows/Tests/badge.svg\n :target: https://github.com/iterative/iterative-telemetry/actions?workflow=Tests\n :alt: Tests\n.. |Codecov| image:: https://codecov.io/gh/iterative/iterative-telemetry/branch/main/graph/badge.svg\n :target: https://app.codecov.io/gh/iterative/iterative-telemetry\n :alt: Codecov\n.. |pre-commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n\n\nFeatures\n--------\n\n* can be disabled in all tools by setting `ITERATIVE_DO_NOT_TRACK=1` env var\n* single anonymised `user_id` across all `iterative` projects\n* collects minimal amount of anonymised data. For example:\n\n.. code:: python\n\n {\n \"tool_name\": \"dvc\",\n \"tool_version\": \"2.14.0\",\n \"user_id\": \"e798d2e2-8941-4f24-a868-3adcbf6467df\",\n \"os_name\": \"mac\",\n \"os_version\": \"12.3\",\n }\n\nRequirements\n------------\n\n* TODO\n\n\nInstallation\n------------\n\nYou can install *Iterative Telemetry* via pip_ from PyPI_:\n\n.. code:: console\n\n $ pip install iterative-telemetry\n\n\nUsage\n-----\n\n\nContributing\n------------\n\nContributions are very welcome.\nTo learn more, see the `Contributor Guide`_.\n\n\nLicense\n-------\n\nDistributed under the terms of the `Apache 2.0 license`_,\n*Iterative Telemetry* is free and open source software.\n\n\nIssues\n------\n\nIf you encounter any problems,\nplease `file an issue`_ along with a detailed description.\n\n\n.. _Apache 2.0 license: https://opensource.org/licenses/Apache-2.0\n.. _PyPI: https://pypi.org/\n.. _file an issue: https://github.com/iterative/iterative-telemetry/issues\n.. _pip: https://pip.pypa.io/\n.. github-only\n.. _Contributor Guide: CONTRIBUTING.rst\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Common library for sending telemetry",
"version": "0.0.9",
"project_urls": {
"Homepage": "https://github.com/iterative/telemetry-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f58ea6897f7a522a28f6790bda0af4a904f2e29cfb737ad7a90d136bfdc152c",
"md5": "03781198eafcbabfa631630a3a391cea",
"sha256": "823688e48ef02f25b1aca2e11ddf700fdea2b97619c6aeee3b47c2a0ee58e527"
},
"downloads": -1,
"filename": "iterative_telemetry-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "03781198eafcbabfa631630a3a391cea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10624,
"upload_time": "2024-09-17T03:54:56",
"upload_time_iso_8601": "2024-09-17T03:54:56.644289Z",
"url": "https://files.pythonhosted.org/packages/1f/58/ea6897f7a522a28f6790bda0af4a904f2e29cfb737ad7a90d136bfdc152c/iterative_telemetry-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7c90c7ec6cfe9d0384bcfbab05f0570878f6859151ef3ce69a8762693b84c03",
"md5": "9709f07db8a80f9a21192b3c22cdc684",
"sha256": "53686c3e912a33e8bf6975b878fd4bd0a7d589c8bad0a6a5573714af9e731dc2"
},
"downloads": -1,
"filename": "iterative_telemetry-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "9709f07db8a80f9a21192b3c22cdc684",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 20079,
"upload_time": "2024-09-17T03:54:58",
"upload_time_iso_8601": "2024-09-17T03:54:58.075923Z",
"url": "https://files.pythonhosted.org/packages/c7/c9/0c7ec6cfe9d0384bcfbab05f0570878f6859151ef3ce69a8762693b84c03/iterative_telemetry-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-17 03:54:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "iterative",
"github_project": "telemetry-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "iterative-telemetry"
}