diff --git a/CHANGELOG.md b/CHANGELOG.md index 093a1bf..5967335 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## 0.2.20dev +* [Feature] Obtain system info once for faster initialization +* [Feature] Add `Telemetry.from_package` for simpler initialization + + ## 0.2.19 (2023-12-12) * [Fix] `@modify_exceptions` decorator now compatible with `ClickException` ([#81](https://github.com/ploomber/core/issues/81)) diff --git a/doc/telemetry.md b/doc/telemetry.md index a955b7e..55da26e 100644 --- a/doc/telemetry.md +++ b/doc/telemetry.md @@ -28,15 +28,12 @@ from ploomber_core.telemetry import Telemetry Initialize it with the API key, name of the package, and version. Here's an example: ```{code-cell} ipython3 -from ploomber_core import __version__ - -telemetry = Telemetry( - api_key="SOMEKEY", - # change for the actual name - package_name="ploomber-core", - # change for the actual version - version=__version__, -) +telemetry = Telemetry.from_package(package_name="ploomber-core") +``` + +```{note} +`Telemetry.from_package` is the simplest way to initialize the telemetry object, you might use the constructor directly if you want to customize +the configuration. ``` To log call functions: