kedro-telemetry0.6.1
Published
Kedro-Telemetry
pip install kedro-telemetry
Package Downloads
Authors
Project URLs
Requires Python
>=3.8
Dependencies
- kedro
>=0.18.0 - requests
~=2.20 - appdirs
>=1.4.4 - bandit
<2.0,>=1.6.2; extra == "test" - black
~=22.0; extra == "test" - mypy
~=1.0; extra == "test" - pre-commit
>=2.9.2; extra == "test" - pytest
; extra == "test" - pytest-cov
; extra == "test" - pytest-mock
; extra == "test" - pytest-xdist
[psutil]~=2.2.1; extra == "test" - PyYAML
==5.3.1; extra == "test" - trufflehog
<3.0,>=2.1.0; extra == "test" - ruff
~=0.0.290; extra == "test" - wheel
; extra == "test" - types-requests
; extra == "test" - types-PyYAML
; extra == "test" - types-toml
; extra == "test"
Kedro-Telemetry
What is kedro-telemetry?
Kedro-Telemetry is a plugin that gathers anonymised and aggregated usage analytics to help the Kedro team understand how Kedro is used and prioritise improvements to the product accordingly.
What data is being collected?
Read our Telemetry documentation for further information on the intent of the data collection and what data is collected.
For technical information on how the telemetry collection works, you can browse
the source code of kedro-telemetry.
How is the data collected
Kedro-Telemetry uses pluggy hooks and requests to send data to Heap Analytics. Project maintainers have access to the data and can create dashboards that show adoption and feature usage.
How do I withdraw consent?
Data collection for telemetry is enabled by default. To withdraw consent, you have a few options:
-
Set Environment Variables: Set the environment variables
DO_NOT_TRACKorKEDRO_DISABLE_TELEMETRYto any value. The presence of any of these environment variables will disable telemetry for all Kedro projects in that environment and will override any consent specified in the.telemetryfile of the specific project. -
CLI Option When Creating a New Project: When creating a new project, you can use the command:
kedro new --telemetry=noThis will create a new project with a
.telemetryfile in its root folder, containingconsent: false. This file will be used when executing Kedro commands within that project folder. Note that telemetry data about the execution of thekedro newcommand will still be sent if telemetry has not been disabled using environment variables.Note: The
.telemetryfile should not be committed togitor packaged in deployment. Inkedro>=0.17.4the file is git-ignored. -
Modify or Create the
.telemetryfile manually: If the.telemetryfile exists in the root folder of your Kedro project, set theconsentvariable tofalse. If the file does not exist, create it with the following content:consent: false -
Uninstall the plugin: Remove the
kedro-telemetryplugin:pip uninstall kedro-telemetryNote: This is a last resort option, as it will break the dependencies of Kedro (for example,
pip checkwill report issues).
What happens when I withdraw consent?
If you explicitly deny consent from the beginning, no data will be collected. If you withdraw consent later, the processing of data will be stopped from that moment on.
What licence do you use?
Kedro-Telemetry is licensed under the Apache 2.0 License.
Python version support policy
- The Kedro-Telemetry supports all Python versions that are actively maintained by the CPython core team. When a Python version reaches end of life, support for that version is dropped from
kedro-telemetry. This is not considered a breaking change.