Skip to content

Build From Source

Jump to bottom
Sumit Sarabhai edited this page Mar 4, 2025 · 5 revisions

Overview

This guide provides step-by-step instructions for building the mssql-python module from source. The process involves setting up a build environment, installing dependencies, compiling the source code, running tests, and publishing the build artifacts.

Steps

  1. Use Python 3.13: This step sets up Python 3.13 on the build agent. It also adds Python to the system path and uses a GitHub token to download the new Python version.

  2. Install Dependencies: This step upgrades pip and installs the required dependencies listed in the requirements.txt file.

  3. Build .pyd File: This step navigates to the pybind directory, creates a build directory, and uses cmake to configure and build the project. The resulting .pyd file is copied to the appropriate location.

  4. Run Tests with Coverage: This step runs the tests using pytest, generates a test results XML file, and collects code coverage information. The database connection string is provided as an environment variable.

  5. Publish .pyd File as Artifact: This step publishes the built .pyd file as a build artifact, making it available for download.

  6. Publish Test Results: This step publishes the test results XML file, allowing you to view the test results in the Azure Pipelines interface.

  7. Publish Code Coverage Results: This step publishes the code coverage results using the Cobertura format. It uses the PublishCodeCoverageResults@1 task to ensure compatibility with the ReportGenerator tool.

Clone this wiki locally