Release Notes for ACCESS-NRI Python/IPython Telemetry Extension
Version: 0.1.0
New Features:
IPython Extensions: Automatically add telemetry to Python usage within IPython environments.
CLI Script: access-ipy-telemetry CLI script to enable, disable, and check the status of telemetry.
IPython Startup Script: Automatically registers telemetry calls for all notebook cells.
Telemetry Configuration: Supports configuration via config.yaml for registering and deregistering functions.
Asynchronous Telemetry Calls: Non-blocking telemetry calls within Jupyter notebooks and new Python processes outside notebooks.
Telemetry Data Handling:
Register functions using TelemetryRegister class.
Decorators for registering functions: ipy_register_func for Jupyter notebooks and register_func for general Python usage.
Add and remove extra fields in telemetry data using ApiHandler.
Session Identifiers: Unique session IDs for tracking user sessions.
Improvements:
Documentation: Comprehensive documentation for configuring and using telemetry.
Overhead Management: Ensures minimal performance impact by making telemetry calls asynchronously.
Credits:
Created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.
Licensing:
Free software: Apache Software License 2.0
Available from PyPI.