Skip to main content

rule official · GitHub

dataverse-python — GitHub Copilot rule: Dataverse SDK for Python

A GitHub Copilot rule that tells the agent how to set up the Dataverse Python SDK: install, environment variables and OAuth.

Install into GitHub Copilot · Manually: put the files in place All methods and platforms ↓

.github/instructions/dataverse-python.instructions.md

What dataverse-python does

The rule covers the Dataverse Python SDK end to end: installing the package, configuring environment variables for the tenant, client ID, secret and resource URL, then authenticating over OAuth and running CRUD operations. The agent gets those steps as context instead of guessing at a connection pattern.

Inside is a short install section using pip install dataverse-sdk, notes on OAuth with an Azure AD app registration, and advice to keep secrets in .env loaded through python-dotenv. A separate block lists common tasks: querying tables, creating and updating rows, batch operations, handling pagination and throttling. The tips section says to reuse clients rather than re-authenticating often, add retries for transient failures and log requests.

You need Python 3.10+, and the rule recommends a virtual environment. Secrets have to exist before anything runs, so check that the Azure AD app registration is in place and .env is filled in — otherwise authentication fails on the first call.

What it helps with

connect Dataverse to a Python script over OAuth
set environment variables for tenant and client ID
query Dataverse tables from Python
create and update rows in batch
handle pagination and throttling on large reads

Example prompts for the agent

set up a Dataverse connection with dataverse-sdk and keep secrets in .env
show me how to authenticate over OAuth and query a table
add retries for transient failures and request logging for Dataverse

How to install dataverse-python

Manually: put the files in place

.github/instructions/dataverse-python.instructions.md

The applyTo field sets which files it applies to

Manually: put the files in place

.claude/rules/dataverse-python.md

The paths frontmatter field limits the files: move applyTo from the source into paths

Manually: put the files in place

.cursor/rules/dataverse-python.mdc

Frontmatter: description, globs, alwaysApply. Move applyTo from the source into globs, or the rule will not attach on its own

Manually: put the files in place

.devin/rules/dataverse-python.md

Manually: put the files in place

.clinerules/dataverse-python.md

Step by step, with commands for each platform: AGENTS.md vs CLAUDE.md: what they are and which one to use

Questions about dataverse-python

How do I install dataverse-python in GitHub Copilot?

Copy the rule file to .github/instructions/dataverse-python.instructions.md in your repository. Copilot then picks it up as chat instructions.

What does dataverse-python do?

It gives the agent a working order for the Dataverse Python SDK: install, environment variables, OAuth authentication and CRUD operations.

What do I need before using the rule?

Python 3.10+ and a virtual environment, which the rule recommends. Secrets live in .env and load through python-dotenv, and an Azure AD app registration must exist.

Source text

dataverse-python.instructions.md · MIT

---
applyTo: '**'
---
# Dataverse SDK for Python — Getting Started

- Install the Dataverse Python SDK and prerequisites.
- Configure environment variables for Dataverse tenant, client ID, secret, and resource URL.
- Use the SDK to authenticate via OAuth and perform CRUD operations.

## Setup
- Python 3.10+
- Recommended: virtual environment

## Install
```bash
pip install dataverse-sdk
```

## Auth Basics
- Use OAuth with Azure AD app registration.
- Store secrets in `.env` and load via `python-dotenv`.

## Common Tasks
- Query tables
- Create/update rows
- Batch operations
- Handle pagination and throttling

## Tips
- Reuse clients; avoid frequent re-auth.
- Add retries for transient failures.
- Log requests for troubleshooting.

© github · MIT · github/awesome-copilot

Similar IDE rules

All IDE rules for Data and databases →

From the same set732

The whole set →

draw-io Tells Copilot how to build and edit draw.io diagrams: mxGraph XML structure, a semantic colour palette, grid alignment and a validation script. ★ 40,418repo stars dotnet-maui This rule steers Copilot toward idiomatic .NET MAUI: MVVM, CollectionView over ListView, Shell navigation. Useful once the agent starts editing XAML and C#. ★ 40,418repo stars devops-core-principles Guides GitHub Copilot on CALMS principles, DORA metrics, and delivery automation across CI/CD pipelines and infrastructure as code. ★ 40,418repo stars devbox-image-definition A GitHub Copilot rule that helps you write YAML image definition files for Microsoft Dev Box Team Customizations. Useful when your customizations rely on ~/winget, ~/gitclone and ~/powershell tasks. ★ 40,418repo stars dataverse-python-sdk This rule gives GitHub Copilot Python SDK examples for Dataverse, from connecting to bulk updates and file uploads. Use it while building code that works with Dataverse. ★ 40,418repo stars dataverse-python-real-world-usecases A Copilot rule with Python templates for Dataverse migration and cleanup, so suggestions follow real integration patterns instead of generic advice. ★ 40,418repo stars dataverse-python-modules The rule hands your agent a map of PowerPlatform.Dataverse: client, config, errors, OData and SQL. Useful whenever Python code talks to Dataverse. ★ 40,418repo stars dataverse-python-file-operations Guides Python file uploads to Microsoft Dataverse via the official SDK. Handles single PATCH uploads, 4 MB chunking for files over 128 MB, and retry loops. ★ 40,418repo stars

Project sponsors

Companies that keep this analytics open

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor