Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ __pycache__
env/
myenv/
.vscode/
.idea/
.stubs/
output/
config.ini
*.pyc
Expand Down
151 changes: 108 additions & 43 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,40 +1,48 @@
# PURVIEW CLI v1.6.3 - Microsoft Purview Automation & Data Governance
# PURVIEW CLI v1.7.0 - Microsoft Purview Automation & Data Governance

[![Version](https://img.shields.io/badge/version-1.6.3-blue.svg)](https://github.com/Keayoub/pvw-cli/releases/tag/v1.6.3)
[![API Coverage](https://img.shields.io/badge/UC%20API%20Coverage-86%25-green.svg)](https://github.com/Keayoub/pvw-cli)
[![Version](https://img.shields.io/badge/version-1.7.0-blue.svg)](https://github.com/Keayoub/pvw-cli/releases/tag/v1.7.0)
[![API Coverage](https://img.shields.io/badge/UC%20API%20Coverage-96%25-brightgreen.svg)](https://github.com/Keayoub/pvw-cli)
[![Lineage](https://img.shields.io/badge/Lineage-Enhanced-green.svg)](https://github.com/Keayoub/pvw-cli)
[![Status](https://img.shields.io/badge/status-stable-success.svg)](https://github.com/Keayoub/pvw-cli)

> **LATEST UPDATE v1.6.3 (January 27, 2026):**
> **LATEST UPDATE v1.7.0 (January 28, 2026):**
>
> **New Unified Catalog APIs - Analytics & Visualization**
>
> - **[NEW]** List Hierarchy Terms - Interactive tree visualization of glossary structure
> - **[NEW]** Get Term Facets - Statistics and filters for glossary terms
> - **[NEW]** Get CDE Facets - Compliance dashboards (GDPR, HIPAA, SOC2)
> - **[NEW]** Get Data Product Facets - Analytics for data product portfolios
> - **[NEW]** Get Objective Facets - OKR dashboards with health metrics
> - **[NEW]** List Related Entities - Complete relationship exploration
> - **[IMPROVED]** UC API Coverage increased from 81% to **96%** (+15%)
> - **[ADDED]** Rich UI with trees, tables, and color-coded outputs
> - **[DOCS]** Comprehensive guides and API coverage analysis
>
> **[Full Release Notes v1.7.0](releases/v1.7.0.md)** | **[New APIs Guide](doc/guides/UC_NEW_APIS_GUIDE.md)** | **[API Coverage Analysis](doc/UC_API_COVERAGE_ANALYSIS.md)**
>
> **Previous Update v1.7.0 (January 27, 2026):**
>
> **Collections Permissions Documentation & Diagnostics**
>
> - **[NEW]** Comprehensive permissions guides (English & French)
> - **[NEW]** Automated diagnostic tools (PowerShell & Python)
> - **[FIXED]** Collections get-details command parameter mappings
> - **[ADDED]** HTTP 403 troubleshooting documentation
> - **[ADDED]** Permission setup scripts (PowerShell & Bash)
>
> **Previous Update v1.6.2 (January 27, 2026):**
>
> **Collections API Conformance**
>
> - **[FIXED]** Complete alignment with Microsoft Purview Collections API specification
> - **[IMPROVED]** All 10+ collection methods have accurate response documentation
> - **[UPDATED]** Collections docstrings reflect actual API response structures
> - **[VERIFIED]** All endpoints match official Microsoft specification
>
> **[Full Release Notes v1.6.3](releases/v1.6.3.md)** | **[v1.6.2 Release Notes](releases/v1.6.2.md)** | **[Archive](releases/)**
> **[Archive](releases/)**

---

## What is PVW CLI?

**PVW CLI v1.6.3** is a modern, full-featured command-line interface and Python library for Microsoft Purview. It enables automation and management of *all major Purview APIs* with **86% Unified Catalog API coverage** (45 of 52 operations).
**PVW CLI v1.7.0** is a modern, full-featured command-line interface and Python library for Microsoft Purview. It enables automation and management of *all major Purview APIs* with **96% Unified Catalog API coverage** (46 of 48 operations).

### Key Capabilities

**Unified Catalog (UC) Management - 86% Complete**
**Unified Catalog (UC) Management - 96% Complete** ⭐ *NEW*
- **[NEW]** Glossary hierarchy visualization with interactive tree views
- **[NEW]** Facets & analytics for terms, CDEs, data products, and objectives
- **[NEW]** Complete relationship exploration for terms
- Complete governance domains, glossary terms, data products, OKRs, CDEs
- Relationships API - Link data products/CDEs/terms to entities and columns
- Query APIs - Advanced OData filtering with multi-criteria search
Expand Down Expand Up @@ -81,34 +89,84 @@ The CLI is designed for data engineers, stewards, architects, and platform teams

For detailed information about previous releases, see the **[Full Release Archive](releases/)**.

**Latest Stable Release:** [v1.6.2](releases/v1.6.2.md) (January 27, 2026)
**Previous Release:** [v1.6.1](releases/v1.6.1.md) (January 20, 2026)
| **Query** | 100% | 4/4 | ✅ Complete |
| **Custom Metadata** | 100% | 5/5 | ✅ Complete |
| **Custom Attributes** | 100% | 5/5 | ✅ Complete |
| **TOTAL** | **86%** | **45/52** | 🎯 **A- Grade** |
**Latest Release:** [v1.7.0](releases/v1.7.0.md) (January 28, 2026)
**Previous Release:** [v1.6.2](releases/v1.6.2.md) (January 27, 2026)

### 🚀 New APIs Implemented
---

## 📊 API Coverage Summary

### Unified Catalog (UC) - 96% Complete ⭐

| Category | Coverage | Count | Status |
|----------|----------|-------|--------|
| **Glossary Terms** | 100% | 9/9 | ✅ Complete |
| **Domains** | 100% | 5/5 | ✅ Complete |
| **Data Products** | 100% | 8/8 | ✅ Complete |
| **Critical Data Elements (CDE)** | 100% | 8/8 | ✅ Complete |
| **Objectives (OKRs)** | 100% | 6/6 | ✅ Complete |
| **Key Results** | 100% | 5/5 | ✅ Complete |
| **Policies** | 100% | 4/4 | ✅ Complete |
| **Facets & Analytics** | 100% | 4/4 | ✅ Complete |
| **Relationships** | 100% | 3/3 | ✅ Complete |
| **Hierarchy** | 100% | 1/1 | ✅ Complete |
| **TOTAL UC** | **96%** | **46/48** | 🎯 **Production Ready** |

1. **Relationships API (6 operations)**
### 🎯 New in v1.7.0 - Six Advanced UC APIs

1. **List Hierarchy Terms (NEW)**
```bash
# Link data product to entity
pvw uc dataproduct link-entity --id <dp-id> --entity-id <guid>
# Interactive tree view of glossary hierarchy
pvw uc term hierarchy --output tree

# Link CDE to column
pvw uc cde link-entity --id <cde-id> --entity-id <guid> --column-qualified-name "..."
# Filter by domain with max depth control
pvw uc term hierarchy --domain-id <domain-guid> --max-depth 3 --output table
```

2. **Query APIs (4 operations)**
2. **Get Term Facets (NEW)**
```bash
# Advanced OData filtering
pvw uc term query --domain-ids "finance" --status Approved --top 50
# Statistics and filters for glossary terms
pvw uc term facets --output table

# Multi-criteria search with pagination
pvw uc dataproduct query --keywords "customer,revenue" --skip 10 --top 25
# JSON export for automation
pvw uc term facets --output json
```

3. **Policy Management (5 operations)**
3. **Get CDE Facets (NEW)**
```bash
# Compliance dashboards (GDPR, HIPAA, SOC2)
pvw uc cde facets --domain-id <domain-guid> --output table

# See color-coded compliance summary
pvw uc cde facets --facet-fields "criticality,compliance_status"
```

4. **Get Data Product Facets (NEW)**
```bash
# Analytics for data product portfolios
pvw uc dataproduct facets --output table

# Filter by domain
pvw uc dataproduct facets --domain-id <domain-guid> --output json
```

5. **Get Objective Facets (NEW)**
```bash
# OKR dashboards with health metrics
pvw uc objective facets --output table

# JSON export for dashboards
pvw uc objective facets --output json
```

6. **List Related Entities (NEW)**
```bash
# Complete relationship exploration for terms
pvw uc term relationships --term-id <term-guid> --output table

# Filter by relationship type (Synonym, Related, Parent)
pvw uc term relationships --term-id <term-guid> --relationship-type "Synonym"
```
---

## Getting Started
Expand Down Expand Up @@ -1451,11 +1509,14 @@ PVW CLI includes comprehensive sample files and scripts for bulk operations:
- Permission management and access control
- Analytics and usage tracking per collection

### **Unified Catalog (UC) - 86% Complete**
### **Unified Catalog (UC) - 96% Complete ⭐ NEW in v1.7.0**

- Governance domains, glossary terms, data products
- Objectives & Key Results (OKRs), Critical Data Elements (CDEs)
- Relationships API for linking data assets
- **[NEW] Hierarchy visualization** - Interactive tree views of glossary structure
- **[NEW] Facets & Analytics** - Statistics for terms, CDEs, data products, objectives
- **[NEW] Impact Analysis** - Complete relationship exploration
- Health monitoring and workflow automation
- Full CRUD operations with smart partial updates

Expand Down Expand Up @@ -1491,6 +1552,8 @@ PVW CLI includes comprehensive sample files and scripts for bulk operations:
## Contributing & Support

- **Documentation:** [Full Documentation](https://github.com/Keayoub/Purview_cli/blob/main/doc/README.md)
- **New APIs Guide:** [UC New APIs v1.7.0](doc/guides/UC_NEW_APIS_GUIDE.md)
- **API Coverage Analysis:** [Complete Coverage Report](doc/UC_API_COVERAGE_ANALYSIS.md)
- **Issue Tracker:** [GitHub Issues](https://github.com/Keayoub/Purview_cli/issues)
- **Email Support:** [keayoub@msn.com](mailto:keayoub@msn.com)
- **Repository:** [GitHub - Keayoub/Purview_cli](https://github.com/Keayoub/Purview_cli)
Expand All @@ -1503,13 +1566,15 @@ See [LICENSE](LICENSE) file for details.

---

**PVW CLI v1.6.2 empowers data engineers, stewards, and architects to automate, scale, and enhance their Microsoft Purview experience with powerful command-line and programmatic capabilities.**
**PVW CLI v1.7.0 empowers data engineers, stewards, and architects to automate, scale, and enhance their Microsoft Purview experience with powerful command-line and programmatic capabilities.**

**Latest in v1.6.2:**
**Latest in v1.7.0:**

- Collections API 100% conformant with Microsoft Purview specification
- Accurate docstrings reflecting actual API response structures
- Complete field mapping documentation for all collection operations
- Enhanced IDE autocomplete and developer experience
- Six new Unified Catalog APIs for analytics and hierarchy visualization
- 96% UC API coverage (46 of 48 operations)
- Rich UI with interactive trees and color-coded tables
- Advanced facets for dashboards and compliance reporting
- Complete relationship exploration for data governance
- Comprehensive documentation and usage guides
- CSV import reliability improvements from v1.6.1
- Bulk operations with comprehensive error handling
Loading