# Client Library

The **Data Access Platform (DAP) Python Client Library** provides a convenient way to interact with DAP’s data resources. Designed for developers, data analysts, and IT admins, this library allows efficient access to datasets, enabling streamlined data queries, transformations, and integrations with other data tools.

Built on top of the [Query API](https://developerdocs.instructure.com/services/dap/query-api), DAP Library provides the following features:

* **Data Retrieval**: Supports both **snapshot** and **incremental** queries for up-to-date data access.
* **Multiple Output Formats**: Retrieves data in popular formats, including **CSV**, **TSV**, **JSONL**, and **Parquet**.
* **Automatic Authentication**: Simplifies OAuth-based access with built-in authentication using client credentials.
* **Synchronize to local databases**: Replicate data to supported SQL databases

Before using DAP Library, it is recommended to familiarize yourself with the [key concepts of DAP](https://developerdocs.instructure.com/services/dap/key-concepts).

## Requirements

* **Supported Operating Systems:** Ubuntu 22, Windows 11 (via [WSL](https://learn.microsoft.com/en-us/windows/wsl/)-based Python only), Windows Server 2022 (via [WSL](https://learn.microsoft.com/en-us/windows/wsl/)-based Python only), MacOS 14+
* **Supported Database Integrations:** PostgreSQL 16.3+, MySQL 8.2+, Microsoft SQL Server 2019+
* **Supported Python Versions:** Python 3.11+

## Download

Get the latest source code on [Pypi](https://pypi.org/project/instructure-dap-client/#files)

Or install it using pip

```sh
pip3 install "instructure-dap-client"
```

## Where To Get Help

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>DAP Community</td><td>Visit our forums to connect with the community and learn more about DAP.</td><td><a href="https://community.canvaslms.com/t5/Data-and-Analytics-Group/gh-p/data">https://community.canvaslms.com/t5/Data-and-Analytics-Group/gh-p/data</a></td></tr><tr><td>Support</td><td>To report bugs or request new features, open a ticket for our Support Team.</td><td><a href="mailto:canvasdatahelp@instructure.com">mailto:canvasdatahelp@instructure.com</a></td></tr></tbody></table>