Skip to content

Release Notes - Version 0.1.1

Released: 2026-02-14

🎉 What's New

  • Pre-commit hooks configuration with 13 hooks (Ruff, Bandit, yamlfmt, markdown linting)
  • Hybrid CI/CD strategy: local pre-commit + GitHub Actions validation
  • Pre-commit hooks comprehensive guide (03.pre-commit-hooks.md) - 541-line complete reference covering all 13 hooks, troubleshooting, best practices, and hybrid CI/CD strategy
  • Complete uv package manager documentation (install, setup, workflow)
  • Daily development workflow guide (02.daily-workflow.md)
  • Python version management guide (01.python-versions.md) - Concise, platform-agnostic version switching guide
  • Dependencies management guide (02.dependencies.md) - Simplified package management with uv
  • Environment management overview (00.overview.md) - Quick reference for virtual environments
  • Getting started README - Directory index with quick start, learning paths
  • Environment README - Directory index following template structure
  • Troubleshooting README - Directory index for troubleshooting guides
  • Numbered prefix convention for sequential documentation (00., 01., 02.)
  • File naming guidelines in markdown.instructions.md
  • Documentation structure updates in copilot-instructions.md
  • Python version pinning with .python-version file (3.12 for development)
  • uv.lock file for deterministic dependency resolution
  • 69 packages installed via uv (verified with 55 passing tests)

✨ Improvements

  • BREAKING: Migration from Poetry to uv: Project now uses uv for 10-100x faster dependency management
  • Build system: Replaced poetry-core with hatchling (standard PEP 621-compliant build backend)
  • Code quality improvements:
  • Python version strategy: Development on 3.12, deployment on 3.11 (EDATEC Gateway compatibility)
  • Documentation reorganization: Split into 01.getting_started/, 02.environment/, and 07.troubleshooting/ folders
  • Documentation format: All guides simplified to 50-60% of original length, platform-agnostic bash commands
  • File naming: All sequential documentation now uses numbered prefixes (00., 01., 02.)
  • Main README.md: Updated badges (Poetry → uv), Python version (3.11+ → 3.12|3.11), all commands (poetry run → uv run)
  • Development README.md: Complete rewrite with quick start, learning path, command reference, status table
  • Getting started README: Applied template structure with directory tree and document index
  • Troubleshooting README: New directory index structure
  • Pre-commit documentation reorganization:
  • All code blocks changed from PowerShell to bash (platform-agnostic)
  • Emphasis on uv run commands throughout documentation
  • Linting strategy: Ruff as primary linter (10-100x faster, auto-fix), Pylint for comprehensive checks only
  • Enhance documentation and migrate to uv package manager (#55)

🗑️ Removed

  • 00.dependencies_setup.md (merged into 00.install-uv.md)
  • 01.project-setup.md (split into daily-workflow.md and first-time-setup.md)
  • Poetry-specific documentation and commands
  • [tool.poetry] configuration from pyproject.toml
  • poetry.lock file (replaced with uv.lock)
  • Poetry badge from README.md
  • Old Poetry virtual environment (.venv renamed to .venv.old_*)
  • Verbose PowerShell examples from all documentation
  • Platform-specific command variations (consolidated to bash)
  • Mermaid diagrams from version management guide
  • Poetry migration sections and advanced topics
  • Duplicate sections (Cache Management, Getting Help) from multiple files
  • Redundant troubleshooting explanations and examples

🔧 Bug Fixes

  • Virtual environment permission issues during migration
  • Documentation cross-references to reflect new structure
  • yamlfmt infinite loop: Added exclusion pattern for .pre-commit-config.yaml, mkdocs.yml, and .github/workflows/release.yml to prevent formatting oscillation
  • YAML formatting configuration: Configured yamlfmt with retain_line_breaks=true, retain_line_breaks_single=true, include_document_start=true, and max_line_length=0 to preserve blank lines and document start markers
  • yamlfmt line ending conversion on Windows: Added line_ending=lf parameter to prevent CRLF conversion on Windows systems
  • Bandit security warnings: Excluded examples directory from Bandit scanning to prevent false positives for example server code binding to 0.0.0.0
  • [tool.poetry] configuration from pyproject.toml
  • poetry.lock file (replaced with uv.lock)
  • Poetry badge from README.md
  • Old Poetry virtual environment (.venv renamed to .venv.old_*)
  • Verbose PowerShell examples from all documentation
  • Platform-specific command variations (consolidated to bash)
  • Mermaid diagrams from version management guide
  • Poetry migration sections and advanced topics
  • Duplicate sections (Cache Management, Getting Help) from multiple files
  • Redundant troubleshooting explanations and examples
  • Virtual environment permission issues during migration
  • Documentation cross-references to reflect new structure
  • yamlfmt infinite loop: Added exclusion pattern for .pre-commit-config.yaml, mkdocs.yml, and .github/workflows/release.yml to prevent formatting oscillation
  • YAML formatting configuration: Configured yamlfmt with retain_line_breaks=true, retain_line_breaks_single=true, include_document_start=true, and max_line_length=0 to preserve blank lines and document start markers
  • yamlfmt line ending conversion on Windows: Added line_ending=lf parameter to prevent CRLF conversion on Windows systems
  • Bandit security warnings: Excluded examples directory from Bandit scanning to prevent false positives for example server code binding to 0.0.0.0

Full Changelog: View on GitHub