search

scorecard-ai / scorecard-python

Python SDK for the Scorecard API
Apache License 2.0
1 stars 0 forks source link

Enable optional installation of telemetry. #35

Closed nathanhammond closed 5 months ago

nathanhammond commented 5 months ago

Usage:

sweep-ai[bot] commented 5 months ago

Sweep: PR Review

README.md

A new "Telemetry" section was added to the README.md file, detailing how to install and use the telemetry package extra and listing AI tools that can be auto-instrumented by the Scorecard SDK.

No issues found with the reviewed changes

pyproject.toml

The changes make several dependencies optional, restructure dev-dependencies, and introduce new extras groups for optional dependencies.

No issues found with the reviewed changes

src/scorecard/telemetry.py

The changes move import statements inside the setup function with error handling and update URL construction for the telemetry endpoint.

Potential Issues

  • Silent handling of ModuleNotFoundError may lead to unnoticed missing modules, causing incomplete instrumentation.
    • https://github.com/scorecard-ai/scorecard-python/blob/932f6c1682dfee7d0121f83b8ea22e9f060c769f/src%2Fscorecard%2Ftelemetry.py#L23-L57 [View Diff](https://github.com/scorecard-ai/scorecard-python/pull/35/files#diff-c444f38787b1d96a3cba6bf2264fb37ac56d4de61e7be4e980e3b4b4f7feb79eR23-R57)