{"id":23298,"library":"avidtools","title":"avidtools","description":"Developer tools for the AVID (Artificial Intelligence Vulnerability Database) ecosystem. Version 0.3.2 requires Python >=3.12. Provides connectors to transform evaluation and compliance outputs into AVID reports, with integrations for Garak, Inspect, and other evaluation frameworks. Actively maintained.","status":"active","version":"0.3.2","language":"python","source_language":"en","source_url":"https://github.com/avidml/avidtools","tags":["avid","vulnerability-database","ai-safety","evaluation","garak","inspect"],"install":[{"cmd":"pip install avidtools","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Data validation and settings management","package":"pydantic","optional":false},{"reason":"YAML file handling for AVID reports","package":"pyyaml","optional":false},{"reason":"HTTP client for API interactions","package":"requests","optional":false},{"reason":"Backport of typing features for older Python versions","package":"typing-extensions","optional":true}],"imports":[{"note":"","wrong":null,"symbol":"avidtools","correct":"import avidtools"},{"note":"Submodules are not auto-imported; import the specific connector directly.","wrong":"import avidtools.connectors.garak as garak_connector","symbol":"avidtools.connectors","correct":"from avidtools.connectors import garak"},{"note":"","wrong":null,"symbol":"avidtools.types","correct":"from avidtools import types"}],"quickstart":{"code":"import avidtools\nfrom avidtools.connectors import garak\n\n# Create an AVID report from a Garak run\nreport = garak.from_output('path/to/garak/log.json')\nprint(report.title)\nprint(report.vulnerability[0].description)\n\n# Optional: set AVID API key via environment variable\n# import os; avidtools.client.set_api_key(os.environ.get('AVID_API_KEY', ''))","lang":"python","description":"Basic usage: import avidtools, use a connector (e.g., garak) to convert evaluation output into an AVID report, then access report fields."},"warnings":[{"fix":"Replace all `connector.enrich(...)` calls with `connector.normalize(...)`.","message":"In version 0.3.0, the 'enrich' terminology was renamed to 'normalize' across connectors. Code using old attribute names like `enrich()` will break.","severity":"breaking","affected_versions":"0.3.0+"},{"fix":"Use `import typing; typing.Protocol` etc. directly if on Python 3.13+.","message":"The `typing-extensions` dependency is only required for Python <3.13. In future versions it may become optional; avoid relying on it for projects targeting Python 3.12+.","severity":"deprecated","affected_versions":"<0.4.0 (estimate)"},{"fix":"Ensure input files are valid JSON/YAML from the respective evaluation framework. Refer to `avidtools.connectors` docs for schema expectations.","message":"Connectors for Garak and Inspect require specific log file formats. Using mismatched input will silently produce empty reports.","severity":"gotcha","affected_versions":"all"},{"fix":"Set `AVID_API_KEY` environment variable or call `avidtools.client.set_api_key('your-key')` before using cloud features.","message":"The `avidtools.client` module requires setting an API key via `set_api_key()` or environment variable `AVID_API_KEY`. Missing API key causes authentication errors with AVID Cloud features.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Use `from avidtools.connectors import inspect` or `import avidtools.connectors.inspect`.","cause":"Trying to import the 'inspect' connector directly from the connectors package which is a namespace package; individual submodules must be imported explicitly.","error":"AttributeError: module 'avidtools.connectors' has no attribute 'inspect'"},{"fix":"Upgrade avidtools to version >=0.2.0: `pip install --upgrade avidtools`","cause":"The 'inspect' connector may not be installed if using an older version (<0.2.0) or if the installation was incomplete.","error":"ModuleNotFoundError: No module named 'avidtools.connectors.inspect'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}