CHORE: Create devcontainer for repo #147

saurabh500 · 2025-07-19T06:41:55Z

Devcontainer: Production-Ready Setup for mssql-python Development

Summary

Refactored the devcontainer with battle-tested improvements from local development use. This provides a complete, zero-config development environment for GitHub Codespaces and local devcontainers.

What's New

🏗️ Build & Setup

Auto-builds C++ extension during container setup (fails fast if broken)
Added unixodbc-dev package - fixes sql.h not found compilation errors
Disabled CMake auto-configure to prevent duplicate/conflicting builds
Moved Python package installation from Dockerfile to post-create for faster image rebuilds

🖥️ ARM64 Support

Detects architecture automatically
Uses Azure SQL Edge on ARM64 (Apple Silicon, ARM Codespaces)
Uses SQL Server 2025 on x86_64

🔌 SQL Server Auto-Setup

Starts SQL Server container via Docker-in-Docker
Generates random secure SA password
Sets DB_CONNECTION_STRING environment variable (persisted to /etc/environment, .bashrc, .zshrc)
Non-fatal if Docker fails - devcontainer still works for builds/tests against remote servers

⚡ Developer Experience

Shell aliases work in both bash and zsh:
- build - Rebuild C++ extension
- test - Run pytest
Clean completion message with quick-start commands

Quick Start

Open in Codespaces / "Reopen in Container"
Wait for setup (~4-5 mins)
python main.py - test connection
test - run all tests

Testing

Tested on macOS ARM64 (Apple Silicon)
Tested in GitHub Codespaces

Fixes #146

…n of virtual environment

saurabh500 · 2025-07-19T06:43:02Z

@microsoft-github-policy-service agree company="Microsoft"

Copilot

Pull Request Overview

This pull request establishes a comprehensive Docker-based development environment for the MSSQL Python Driver project using VS Code devcontainer technology. The setup enables developers to quickly spin up a consistent development environment with all necessary dependencies pre-configured.

Creates a complete devcontainer configuration with Python 3.10, Microsoft ODBC drivers, and development tools
Implements automated environment setup through post-creation scripts and Docker configuration
Adds Docker build optimization through comprehensive file exclusion patterns

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 13 comments.

File	Description
`.dockerignore`	Excludes build artifacts, caches, and IDE files from Docker context
`.devcontainer/Dockerfile`	Defines container with Python 3.10, MSSQL drivers, and development tools
`.devcontainer/devcontainer.json`	Configures VS Code settings, extensions, and container features
`.devcontainer/post-create.sh`	Automates post-container setup including dependencies and virtual environment

.dockerignore

.devcontainer/Dockerfile

.devcontainer/devcontainer.json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

bewithgaurav

some refactoring & optimization comments

.devcontainer/Dockerfile

bewithgaurav · 2025-07-23T10:37:46Z

.devcontainer/Dockerfile

+# Upgrade pip and install common Python development tools
+RUN python -m pip install --upgrade pip setuptools wheel \
+    && pip install \
+    black \


we have the minimum requirements available in requirements.txt - as seen in post-create script we're using pip install -r requirements.txt already. we can skip this here/there probably.

.devcontainer/Dockerfile

.dockerignore

dlevy-msft-sql · 2026-01-19T22:37:38Z

@saurabh500 bumping this because it would be nice to have. Are we close on this PR or is it better to start fresh since it has been a while?

github-actions · 2026-01-19T22:49:26Z

📊 Code Coverage Report

🔥 Diff Coverage 100%	🎯 Overall Coverage 76%	📈 Total Lines Covered: `5472` out of `7137` 📁 Project: `mssql-python`

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

No lines with coverage information in this diff.

📋 Files Needing Attention

📉 Files with overall lowest coverage (click to expand)

mssql_python.pybind.logger_bridge.hpp: 58.8%
mssql_python.pybind.logger_bridge.cpp: 59.2%
mssql_python.row.py: 66.2%
mssql_python.pybind.ddbc_bindings.cpp: 69.3%
mssql_python.pybind.ddbc_bindings.h: 69.7%
mssql_python.pybind.connection.connection.cpp: 75.3%
mssql_python.ddbc_bindings.py: 79.6%
mssql_python.pybind.connection.connection_pool.cpp: 79.6%
mssql_python.connection.py: 84.1%
mssql_python.cursor.py: 84.7%

🔗 Quick Links

⚙️ Build Summary	📋 Coverage Details
View Azure DevOps Build	Browse Full Coverage Report

bewithgaurav · 2026-02-04T09:04:29Z

I've been using an ubuntu devcontainer for mssql-python since some time now, and have some more improvements to this that we can add here
I'll resolve the comments and add some modifications to this so we can merge this off

cc: @saurabh500

…, ARM64 support - Add unixodbc-dev package for ODBC headers (fixes sql.h not found) - Move Python package installation from Dockerfile to post-create.sh - Add ARM64 support: use Azure SQL Edge instead of SQL Server 2025 - Make SQL Server container startup non-fatal (optional) - Fix false success reporting when build fails - Disable CMake auto-configure to prevent duplicate builds - Generate random SA password and store connection string

.devcontainer/post-create.sh

saurabh500 · 2026-02-04T09:40:44Z

@bewithgaurav all yours. I haven't had the bandwidth to pick this up.
Since you have been active in this area, you will do better at driving this.

- Add aliases for both bash and zsh - Persist DB_CONNECTION_STRING to /etc/environment and shell rc files - Improve completion message with quick start commands

.devcontainer/post-create.sh

Saurabh Singh added 2 commits July 19, 2025 06:00

Dev Container setup

a93e2ff

REFACTOR: Simplify post-create script by removing redundant activatio…

2383b7b

…n of virtual environment

Copilot AI review requested due to automatic review settings July 19, 2025 06:41

Copilot AI reviewed Jul 19, 2025

View reviewed changes

saurabh500 changed the title ~~Create devcontainer for repo~~ CHORE: Create devcontainer for repo Jul 19, 2025

saurabh500 and others added 7 commits July 18, 2025 23:44

Update .dockerignore

1f50584

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .devcontainer/Dockerfile

6f79cd2

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .dockerignore

1e4c8cc

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .dockerignore

92b1c1f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .dockerignore

78d129f

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .devcontainer/devcontainer.json

b5e940a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Update .devcontainer/devcontainer.json

306ae47

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

saurabh500 requested review from Theekshna, bewithgaurav, dlevy-msft-sql, jahnvi480 and sumitmsft July 19, 2025 18:40

saurabh500 and others added 3 commits July 19, 2025 11:41

Apply suggestions from code review

386b81b

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge branch 'main' into devcontainer

9dd343b

Merge branch 'main' into devcontainer

19f635e

bewithgaurav requested changes Jul 24, 2025

View reviewed changes

Merge branch 'main' into devcontainer

6427ac6

dlevy-msft-sql assigned saurabh500 Jan 31, 2026

dlevy-msft-sql added enhancement New feature or request pr-size: medium Moderate update size under development labels Jan 31, 2026

CHORE: Upgrade to Python 3.14, fix duplicate ODBC, modernize settings

f534e5c

Merge branch 'main' into devcontainer

4ad071d

dlevy-msft-sql previously approved these changes Feb 3, 2026

View reviewed changes

bewithgaurav added 2 commits February 4, 2026 14:34

Merge branch 'main' into devcontainer

651f576

bewithgaurav dismissed dlevy-msft-sql’s stale review via 37ecdff February 4, 2026 09:30

github-advanced-security bot found potential problems Feb 4, 2026

View reviewed changes

.devcontainer/post-create.sh Fixed Show fixed Hide fixed

fix(devcontainer): improve shell aliases and connection string setup

33f3611

- Add aliases for both bash and zsh - Persist DB_CONNECTION_STRING to /etc/environment and shell rc files - Improve completion message with quick start commands

github-advanced-security bot found potential problems Feb 4, 2026

View reviewed changes

.devcontainer/post-create.sh Dismissed Show dismissed Hide dismissed

.devcontainer/post-create.sh Dismissed Show dismissed Hide dismissed

CHORE: Create devcontainer for repo #147

Are you sure you want to change the base?

CHORE: Create devcontainer for repo #147

Conversation

saurabh500 commented Jul 19, 2025 • edited by bewithgaurav Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Devcontainer: Production-Ready Setup for mssql-python Development

Summary

What's New

Quick Start

Testing

Uh oh!

saurabh500 commented Jul 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bewithgaurav left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bewithgaurav Jul 23, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlevy-msft-sql commented Jan 19, 2026

Uh oh!

github-actions bot commented Jan 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📊 Code Coverage Report

🔥 Diff Coverage

100%

🎯 Overall Coverage

76%

Diff Coverage

Diff: main...HEAD, staged and unstaged changes

📋 Files Needing Attention

🔗 Quick Links

Uh oh!

bewithgaurav commented Feb 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

saurabh500 commented Feb 4, 2026

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

saurabh500 commented Jul 19, 2025 •

edited by bewithgaurav

Loading

github-actions bot commented Jan 19, 2026 •

edited

Loading

bewithgaurav commented Feb 4, 2026 •

edited

Loading