ITW Python Builder

Standardized Django deployment pipeline with Docker, testing, SonarQube integration, automatic changelog generation, and code quality enforcement.

Features

Automated deployment with semantic versioning
Docker/Podman-based build and push pipeline
Automated testing with coverage
SonarQube static code analysis
Pylint linting with SonarQube integration
Quality gates - deploy only when tests pass
Automatic changelog generation from commit trailers
Support for local and production pipelines
Global CLI tool
Automatic venv detection per project

Installation

pip install itw-python-builder

Install globally (outside any project venv). The itw command becomes available system-wide.

Quick Start

Navigate to your Django project directory (must have a .venv or venv):
Initialize versioning:

itw tag-init

Run local pipeline:

itw pipelinelocal

Deploy to staging:

itw incrementrc

Deploy to production:

itw incrementpatch

Available Commands

Deployment Commands

itw incrementpatch — Increment patch version and deploy
itw incrementminor — Increment minor version and deploy
itw incrementmajor — Increment major version and deploy
itw incrementrc — Increment release candidate (staging)
itw release — Promote RC to stable release (master)

Local Development Commands

itw pipelinelocal — Run full local pipeline (lint → test → analyze → build)
itw lintlocal — Run pylint with human-readable output
itw lint — Run pylint and generate SonarQube report files
itw buildlocal — Build Docker image locally
itw testlocal — Run tests locally
itw analyzelocal — Run SonarQube analysis locally
itw changelog — Generate changelog manually
itw tag-init — Initialize version tagging

Skip Pipeline

itw incrementpatch --skip-pipeline

Virtual Environment Detection

itw is installed globally but automatically detects the project's virtual environment (.venv or venv) in the current directory. Tasks that need Python/Django dependencies (test, lint, analyze) activate the venv automatically — no need to manually activate it.

If no venv is found, those tasks will error with a clear message. Tasks that only use git (like changelog, tag-init, buildlocal) work without a venv.

Linting

The pipeline runs pylint automatically on every deployment and generates report files for SonarQube. The .pylintrc configuration is shipped with the package — no config files needed in your project.

# Review issues with human-readable output
itw lintlocal

# Generate report files for SonarQube
itw lint

Add this to your sonar-project.properties:

sonar.python.pylint.reportPaths=pylint-report.txt

Changelog Generation

Changelog entries are generated automatically on every deployment based on commit messages. To categorize a commit, add a Changelog: trailer to the commit body:

add user authentication

Changelog: added

Available categories: added, fixed, changed, deprecated, removed, security, performance, tests, docs, refactor

Commits without a trailer appear under Other Changes. The CHANGELOG.md file is committed and pushed automatically with each deployment.

Requirements

Python 3.10+
Podman
Git
SonarQube server

Configuration

Environment Variables

Add to your project .env:

SONAR_HOST_URL=https://your-sonar-server
SONAR_TOKEN=your-token
GIT_DEPTH=0

Project Files Required

Git repository with develop, staging, and master branches
VERSION file in project root
Dockerfile
sonar-project.properties

License

MIT

Metadata

Release files for itw-python-builder 0.2.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for itw-python-builder 0.2.12
File	Size	Uploaded
itw_python_builder-0.2.12.tar.gz	39.4 kB	Jul 30, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for itw-python-builder 0.2.12
File	Interpreter	ABI	Platform	Reset
itw_python_builder-0.2.12-py3-none-any.whl 42.1 kB Jul 30, 2026	Python 3	none	any	Details

Total release size: 81.4 kB

Release files / itw_python_builder-0.2.12.tar.gz

Download URL	itw_python_builder-0.2.12.tar.gz
Size	39.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`078c38e2936761352b646c6768dc8f1ce361e5b821156d2add8aa61665df6d5b`
BLAKE2b-256 checksum How to use checksums	`649b3ee0e5c397a4447adf69a8aa9f7a8ada7c978a54af2ef21a8244fc58b633`
Upload date	Jul 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.13`

Release files / itw_python_builder-0.2.12-py3-none-any.whl

Download URL	itw_python_builder-0.2.12-py3-none-any.whl
Size	42.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`07aaeb0814c1aaba1608c373d5fafde2868583d91c60a74959cdb8800318dda1`
BLAKE2b-256 checksum How to use checksums	`ce8636536e118d96ada594302c59e5ed40813b82b48596f3f5f7e75680267d6d`
Upload date	Jul 30, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.12.13`