Extract Azure DevOps Pull Request metrics to SQLite and generate PowerBI-compatible CSVs.
Project description
ado-git-repo-insights
Extract Azure DevOps Pull Request metrics to SQLite and generate PowerBI-compatible CSVs.
Overview
This tool replaces the MongoDB-based ado-pull-request-metrics with a lightweight, file-based solution that:
- Stores data in SQLite - No external database required
- Runs as an Azure DevOps Pipeline Task - Scheduled daily extraction
- Preserves the PowerBI CSV contract - Same filenames, columns, and ordering
- Supports incremental + backfill extraction - Efficient daily updates with periodic convergence
Quick Start
Installation
pip install ado-git-repo-insights
Usage Options
This tool provides two ways to extract Azure DevOps Pull Request metrics:
| Aspect | CLI (Option 1) | Extension (Option 2) |
|---|---|---|
| Requires Python | Yes | No (bundled) |
| Installation | pip install |
Upload VSIX to ADO |
| Pipeline syntax | Script steps | Task step |
| Works outside ADO | Yes | No (ADO only) |
| Flexibility | Higher | Standard |
Option 1: Python CLI
Best for users comfortable with Python/pip, custom scripts, and non-ADO CI/CD systems.
First Run (Extract Data)
ado-insights extract \
--organization MyOrg \
--projects "ProjectOne,ProjectTwo" \
--pat $ADO_PAT \
--database ./ado-insights.sqlite
Note: End date defaults to yesterday (to avoid incomplete data). Include today:
--end-date $(date +%Y-%m-%d)(Bash) or--end-date (Get-Date -Format yyyy-MM-dd)(PowerShell)
Generate CSVs
ado-insights generate-csv \
--database ./ado-insights.sqlite \
--output ./csv_output
Backfill Mode (Weekly Convergence)
ado-insights extract \
--organization MyOrg \
--projects "ProjectOne,ProjectTwo" \
--pat $ADO_PAT \
--database ./ado-insights.sqlite \
--backfill-days 60
Option 2: Azure DevOps Extension
Best for teams that prefer the ADO pipeline editor UI or want a self-contained task without managing Python dependencies.
steps:
- task: ExtractPullRequests@1
inputs:
organization: 'MyOrg'
projects: 'Project1,Project2'
pat: '$(PAT_SECRET)'
database: '$(Pipeline.Workspace)/data/ado-insights.sqlite'
outputDir: '$(Pipeline.Workspace)/csv_output'
Installation:
- Download the
.vsixfrom GitHub Releases - Install in your ADO organization: Organization Settings → Extensions → Browse local extensions
Configuration
Create a config.yaml file:
organization: MyOrg
projects:
- ProjectOne
- ProjectTwo
- Project%20Three # URL-encoded names supported
api:
base_url: https://dev.azure.com
version: 7.1-preview.1
rate_limit_sleep_seconds: 0.5
max_retries: 3
retry_delay_seconds: 5
retry_backoff_multiplier: 2.0
backfill:
enabled: true
window_days: 60
Then run:
ado-insights extract --config config.yaml --pat $ADO_PAT
Azure DevOps Pipeline Integration
See sample-pipeline.yml for a complete example.
Scheduled Daily Extraction
schedules:
- cron: "0 6 * * *" # Daily at 6 AM UTC
displayName: "Daily PR Extraction"
branches:
include: [main]
always: true
Weekly Backfill
schedules:
- cron: "0 6 * * 0" # Weekly on Sunday
displayName: "Weekly Backfill"
branches:
include: [main]
always: true
CSV Output Contract
The following CSVs are generated with exact schema and column order for PowerBI compatibility:
| File | Columns |
|---|---|
organizations.csv |
organization_name |
projects.csv |
organization_name, project_name |
repositories.csv |
repository_id, repository_name, project_name, organization_name |
pull_requests.csv |
pull_request_uid, pull_request_id, organization_name, project_name, repository_id, user_id, title, status, description, creation_date, closed_date, cycle_time_minutes |
users.csv |
user_id, display_name, email |
reviewers.csv |
pull_request_uid, user_id, vote, repository_id |
Governance
This project is governed by authoritative documents in agents/:
- INVARIANTS.md - 25 non-negotiable invariants
- definition-of-done.md - Completion criteria
- victory-gates.md - Verification gates
Development
# Setup
python -m venv .venv
source .venv/bin/activate # or .venv\Scripts\activate on Windows
pip install -e .[dev]
# Lint + Format
ruff check .
ruff format .
# Type Check
mypy src/
# Test
pytest
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ado_git_repo_insights-2.1.1.tar.gz.
File metadata
- Download URL: ado_git_repo_insights-2.1.1.tar.gz
- Upload date:
- Size: 483.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2b2bca17803715b6e9870825fda6d624ba99af991f40516c260a71e0d2267a3f
|
|
| MD5 |
c2e9dbd642f455cf48fc75676a2efe2a
|
|
| BLAKE2b-256 |
93658b3b46bdeb5849c78f6c78bcd01688d563f7f9860111eda44263df28d40d
|
Provenance
The following attestation bundles were made for ado_git_repo_insights-2.1.1.tar.gz:
Publisher:
release.yml on oddessentials/ado-git-repo-insights
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ado_git_repo_insights-2.1.1.tar.gz -
Subject digest:
2b2bca17803715b6e9870825fda6d624ba99af991f40516c260a71e0d2267a3f - Sigstore transparency entry: 820760154
- Sigstore integration time:
-
Permalink:
oddessentials/ado-git-repo-insights@a7008d65c89e70bbd6b5b12732b963fec1577210 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/oddessentials
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a7008d65c89e70bbd6b5b12732b963fec1577210 -
Trigger Event:
push
-
Statement type:
File details
Details for the file ado_git_repo_insights-2.1.1-py3-none-any.whl.
File metadata
- Download URL: ado_git_repo_insights-2.1.1-py3-none-any.whl
- Upload date:
- Size: 30.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ebf2b4916d6b77fb99797db2de37878e590c48356639bdcd3ed47cc1b1ee68ea
|
|
| MD5 |
54195331e380413160a06939c4493866
|
|
| BLAKE2b-256 |
ffb4525476fbcd819ce13dc2f4b9416fdb988ce5a290b4757cce3afb69d31aba
|
Provenance
The following attestation bundles were made for ado_git_repo_insights-2.1.1-py3-none-any.whl:
Publisher:
release.yml on oddessentials/ado-git-repo-insights
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
ado_git_repo_insights-2.1.1-py3-none-any.whl -
Subject digest:
ebf2b4916d6b77fb99797db2de37878e590c48356639bdcd3ed47cc1b1ee68ea - Sigstore transparency entry: 820760158
- Sigstore integration time:
-
Permalink:
oddessentials/ado-git-repo-insights@a7008d65c89e70bbd6b5b12732b963fec1577210 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/oddessentials
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@a7008d65c89e70bbd6b5b12732b963fec1577210 -
Trigger Event:
push
-
Statement type: