Skip to content

Commit 5c6cdf8

Browse files
committed
Prepare for PyPI release: Update changelog and modernize packaging
- Update CHANGELOG.md for 0.1.0b1 release (2025-11-14) - Organize features into logical groups for better readability - Remove legacy requirements.txt and dev_dependencies.txt files - Modernize to pyproject.toml-only packaging approach - Clean up changelog format for professional presentation - Fix documentation links in README. These links will get active once published. Ready for first beta release to PyPI.
1 parent daedd9c commit 5c6cdf8

4 files changed

Lines changed: 35 additions & 68 deletions

File tree

CHANGELOG.md

Lines changed: 34 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,42 @@
22

33
All notable changes to this project will be documented in this file.
44

5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7-
8-
## [Unreleased]
5+
## [0.1.0b1] - 2025-11-14
96

107
### Added
11-
- Initial SDK implementation with CRUD operations
12-
- Service principal authentication support
13-
- Interactive browser authentication support
14-
- SQL query execution via `query_sql()`
15-
- File upload capabilities
16-
- Pandas integration for query results
17-
- Structured error handling with specific exception types
18-
- GitHub Actions CI pipeline for automated testing
8+
**Initial beta release** of Microsoft Dataverse SDK for Python
9+
10+
**Core Client & Authentication:**
11+
- Core `DataverseClient` with Azure Identity authentication support
12+
- Secure authentication using Azure Identity credentials (Service Principal, Managed Identity, Interactive Browser)
13+
- TLS 1.2+ encryption for all API communications
14+
- Proper credential handling without exposing secrets in logs
15+
16+
**Data Operations:**
17+
- Complete CRUD operations (create, read, update, delete) for Dataverse records
18+
- Advanced OData query support with filtering, sorting, and expansion
19+
- SQL query execution via `query_sql()` method with result pagination
20+
- Support for batch operations and transaction handling
21+
- File upload capabilities for file and image columns
22+
23+
**Table Management:**
24+
- Table metadata operations (create, inspect, delete custom tables)
25+
26+
**Integration & Analysis:**
27+
- Pandas DataFrame integration for seamless data analysis workflows
28+
29+
**Reliability & Error Handling:**
30+
- Comprehensive error handling with specific exception types (`DataverseError`, `AuthenticationError`, etc.)
31+
- HTTP retry logic with exponential backoff for resilient operations
32+
33+
**Developer Experience:**
34+
- Example scripts demonstrating common integration patterns
35+
- Complete documentation with quickstart guides and API reference
36+
- Modern Python packaging using `pyproject.toml` configuration
37+
38+
**Quality Assurance:**
39+
- Comprehensive test suite with unit and integration tests
40+
- GitHub Actions CI/CD pipeline for automated testing and validation
1941
- Azure DevOps PR validation pipeline
2042

2143
### Changed
@@ -32,42 +54,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3254

3355
### Security
3456
- N/A
35-
36-
## [0.1.0] - TBD
37-
38-
### Added
39-
- First alpha release
40-
- Core Dataverse client with authentication
41-
- Basic CRUD operations (create, get, update, delete)
42-
- OData query support
43-
- SQL query support
44-
- Error handling framework
45-
- Example scripts for common scenarios
46-
47-
---
48-
49-
## Release Notes Template
50-
51-
When creating a new release, copy this template:
52-
53-
```markdown
54-
## [X.Y.Z] - YYYY-MM-DD
55-
56-
### Added
57-
- New features
58-
59-
### Changed
60-
- Changes in existing functionality
61-
62-
### Deprecated
63-
- Soon-to-be removed features
64-
65-
### Removed
66-
- Removed features
67-
68-
### Fixed
69-
- Bug fixes
70-
71-
### Security
72-
- Security improvements or fixes
73-
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
A Python client library for Microsoft Dataverse that provides a unified interface for CRUD operations, SQL queries, table metadata management, and file uploads through the Dataverse Web API.
88

9-
**[Source code](https://github.com/microsoft/PowerPlatform-DataverseClient-Python)** | **[Package (PyPI)](https://pypi.org/project/PowerPlatform-Dataverse-Client/)** | **[API reference documentation](https://github.com/microsoft/PowerPlatform-DataverseClient-Python/tree/main/examples)** | **[Product documentation](https://learn.microsoft.com/power-apps/developer/data-platform/)** | **[Samples](https://github.com/microsoft/PowerPlatform-DataverseClient-Python/tree/main/examples)**
9+
**[Source code](https://github.com/microsoft/PowerPlatform-DataverseClient-Python)** | **[Package (PyPI)](https://pypi.org/project/PowerPlatform-Dataverse-Client/)** | **[API reference documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/sdk-python/)** | **[Product documentation](https://learn.microsoft.com/en-us/python/api/dataverse-sdk-docs-python/dataverse-overview?view=dataverse-sdk-python-latest/)** | **[Samples](https://github.com/microsoft/PowerPlatform-DataverseClient-Python/tree/main/examples)**
1010

1111
> [!IMPORTANT]
1212
> This library is currently in **preview**. Preview versions are provided for early access to new features and may contain breaking changes.

dev_dependencies.txt

Lines changed: 0 additions & 10 deletions
This file was deleted.

requirements.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)