Skip to content

Conversation

@tpellissier-msft
Copy link
Collaborator

Adds YAML definitions for 1) Public PR pipelines via GitHub actions (python-package.yml) and 2) ADO-side CI and validation (ci-pr.yaml). Tries to follow the same organization as https://github.com/microsoft/Agents-for-python.

With these in place, next step will be to add internal YAML definition on the ADO side to build/validate/publish.

Copilot summary:

This pull request establishes foundational infrastructure for the project, including CI/CD pipelines, development tooling, and initial metadata. The most important changes are the addition of GitHub Actions and Azure DevOps pipelines for automated testing, development dependency management, project metadata updates, and documentation of release notes and changelog procedures.

Continuous Integration & Testing

  • Added a GitHub Actions workflow (.github/workflows/python-package.yml) for automated testing and linting on pushes and pull requests to main, using Python 3.12 and standard tools (black, flake8, pytest).
  • Added an Azure DevOps PR validation pipeline (.azdo/ci-pr.yaml) that mirrors the GitHub Actions workflow for consistency, also using Python 3.12.

Development Tooling

  • Introduced a dev_dependencies.txt file listing development dependencies such as pytest, black, flake8, and build tools for local and CI use.
  • Added a .flake8 configuration file to enforce code style and complexity limits, specifying exclusions for common build and environment folders.

Project Metadata & Documentation

  • Updated pyproject.toml to refine project metadata: renamed the package to dataverse-client-python, updated author/license info, added classifiers, and set up project URLs.
  • Added a CHANGELOG.md file following the Keep a Changelog format, documenting initial features and providing a template for future releases.
  • Added a __version__ module and exposed version information in the package’s public API (src/dataverse_sdk/__init__.py, src/dataverse_sdk/__version__.py). [1] [2]

Copilot AI review requested due to automatic review settings November 3, 2025 19:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR prepares the dataverse-client-python package for initial release by improving project metadata, build configuration, and establishing development workflows.

  • Package renamed from "dataverse-python-client" to "dataverse-client-python" with standardized metadata
  • Version management moved to dedicated __version__.py module
  • Development dependencies separated from production dependencies, with CI/CD pipelines added

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/dataverse_sdk/version.py Adds dedicated version module for package versioning
src/dataverse_sdk/init.py Exports version information alongside client
pyproject.toml Updates package metadata, removes pytest from production dependencies, and standardizes configuration
dev_dependencies.txt Separates development tools from production dependencies
CHANGELOG.md Adds changelog following Keep a Changelog format
.github/workflows/python-package.yml Adds GitHub Actions CI workflow for testing and validation
.flake8 Adds flake8 linting configuration
.azdo/ci-pr.yaml Adds Azure DevOps PR validation pipeline

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@tpellissier-msft tpellissier-msft merged commit 7d24791 into main Nov 3, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants