> For the complete documentation index, see [llms.txt](https://docs.avidml.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.avidml.org/developer-tools/python-sdk.md).

# Python SDK

The `avidtools` package is the official Python toolkit for working with AVID resources. It empowers engineers and developers build pipelines to export outcomes of tests in their ML pipelines as AVID reports, build an in-house vulnerability database, integrate existing sources of vulnerabilities into AVID-style reports, and much more!

### Features

* 📎 **Data models**: definition of AVID report/vulnerability schema as [pydantic](https://docs.pydantic.dev/) models
* 🏄 **Connectors**: ingestion from relevant data sources, e.g. MITRE ATLAS case studies and NIST CVEs

In this section, we'll provide overview and usage examples for `avidtools`. For more details, check out the [API Reference](https://avidml.org/avidtools).

### Installation

To install `avidtools` from PyPI, run:

```
pip install avidtools
```

To install the latest development version from GitHub, use:

```bash
python -m pip install -U git+https://github.com/avidml/avidtools.git@main
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.avidml.org/developer-tools/python-sdk.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.