development · Command reference
qzx scaffoldPython
What it does
Creates a basic scaffolding for a Python program
Command maturity: Alpha
Available for real use and feedback while its interface and behavior can still evolve. This is the current development-checkout assessment. Every future immutable release tag preserves the exact assessment shipped by that version. Available in PyPI 0.2.2.0.15. This page documents the 0.2.2.0.15 alpha development checkout.
Behavior and built-in protections
Live mode applies the changes you request
Direct execution for this operation
Uses a native tool when needed
Works without network access
No elevation required by design
This safety classification was reviewed by Claude Opus 5.5 (Anthropic) against implementation digest sha256:207c52ef2cd531e5f2baa76ace2a972a547c1e9d6e642d4f89a1e983451345b6 on 2026-10-08.
Exact syntax
qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --jsonParameters
Swipe or use the horizontal scrollbar to see every column.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| project_name | str | Yes | Not declared | Name of the Python project to create |
| path | str | No | "." | Path where to create the project (default: current directory) |
| with_tests | bool | No | true | Whether to include test scaffolding (pytest) |
| create_venv | bool | No | false | Whether to create a virtual environment |
Input examples
qzx scaffoldPython my_projectCreates a new Python project named "my_project" in the current directory
qzx scaffoldPython my_project /path/to/dir true trueCreates a new Python project with tests and virtual environment in the specified directory
qzx scaffoldPython api_service . falseCreates a new Python project named "api_service" without tests in the current directory
For the complete structured payload, add --json: qzx scaffoldPython <project_name> [path] [with_tests] [create_venv] --json
Representative output example
This illustrative JSON is derived from the current implementation-backed result contract. It shows what the command can return without claiming a recorded execution; values vary with inputs, host, permissions, and optional tools.
Example command: qzx scaffoldPython my_project --json
{
"success": true,
"message": "Creates a basic scaffolding for a Python program. In this illustrative example, the command completed successfully.",
"meta": {
"command": "scaffoldPython",
"command_maturity": {
"stage": "alpha",
"label": "Alpha",
"sequence": 2,
"public_executable": true,
"stability": "interface_may_change",
"summary": "Available for real use and feedback while its interface and behavior can still evolve.",
"promotion_review_required": false,
"assessment_scope": "development_checkout"
},
"duration_ms": 0,
"schema_version": 1
},
"create_venv": true,
"files_created": [
"C:\\project\\example.txt"
],
"name_was_normalized": true,
"next_steps": [
{
"id": "run",
"description": "Example value",
"cwd": "Example value",
"argv": [
"Example value"
]
}
],
"partial": true,
"project_name": "Example value",
"project_path": "C:\\project\\example.txt",
"report": "Analysis complete.\nNo blocking issues were found.",
"requested_project_name": "Example value",
"timestamp": "Example value",
"virtual_environment": {
"requested": true,
"status": "not_requested",
"path": "C:\\project\\example.txt",
"python": "Example value",
"message": "Example value"
},
"warnings": [
"Example value"
],
"with_tests": true
}View the JSON result contract
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"required": [
"message",
"meta",
"success"
],
"properties": {
"success": {
"type": "boolean"
},
"message": {
"type": "string"
},
"project_name": {
"description": "Normalized project name on success; original input on validation errors."
},
"project_path": {
"type": "string"
},
"with_tests": {
"type": "boolean"
},
"files_created": {
"type": "array",
"items": {
"type": "string"
}
},
"timestamp": {
"type": "string"
},
"partial": {
"type": "boolean"
},
"error": {
"type": "string"
},
"error_code": {
"type": "string"
},
"create_venv": {
"type": "boolean"
},
"requested_project_name": {
"type": "string"
},
"name_was_normalized": {
"type": "boolean"
},
"virtual_environment": {
"type": "object",
"required": [
"requested",
"status"
],
"properties": {
"requested": {
"type": "boolean"
},
"status": {
"enum": [
"not_requested",
"created",
"failed"
]
},
"path": {
"type": "string"
},
"python": {
"type": "string"
},
"message": {
"type": "string"
}
},
"additionalProperties": true,
"allOf": [
{
"if": {
"properties": {
"status": {
"const": "created"
}
}
},
"then": {
"required": [
"path",
"python"
],
"properties": {
"requested": {
"const": true
}
}
}
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"report": {
"type": "string"
},
"next_steps": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"description",
"cwd",
"argv"
],
"properties": {
"id": {
"type": "string",
"enum": [
"run",
"install",
"test",
"build"
]
},
"description": {
"type": "string"
},
"cwd": {
"type": "string"
},
"argv": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
}
},
"additionalProperties": true
},
"description": "Suggested argv/cwd actions; QZX has not executed them."
},
"meta": {
"type": "object",
"required": [
"command",
"command_maturity",
"duration_ms",
"schema_version"
],
"properties": {
"command": {
"type": "string"
},
"command_maturity": {
"type": "object",
"required": [
"stage",
"label",
"sequence",
"public_executable",
"stability",
"summary",
"promotion_review_required",
"assessment_scope"
],
"properties": {
"stage": {
"type": "string"
},
"label": {
"type": "string"
},
"sequence": {
"type": "integer"
},
"public_executable": {
"type": "boolean"
},
"stability": {
"type": "string"
},
"summary": {
"type": "string"
},
"promotion_review_required": {
"type": "boolean"
},
"assessment_scope": {
"type": "string"
},
"note": {
"type": "string"
},
"review": {
"type": "object",
"required": [
"reviewed_on",
"rationale",
"evidence"
],
"properties": {
"reviewed_on": {
"type": "string",
"format": "date"
},
"rationale": {
"type": "string"
},
"evidence": {
"type": "array",
"minItems": 1,
"items": {
"type": "string"
}
},
"replacement": {
"type": "string"
}
},
"additionalProperties": false
}
},
"additionalProperties": true
},
"duration_ms": {
"type": "number"
},
"schema_version": {
"type": "integer"
}
},
"additionalProperties": true
}
},
"additionalProperties": true
}Errors and limits
The public contract requires success=false and a descriptive message on failure. This catalog does not yet declare a command-specific error taxonomy; inspect the result and do not invent error codes.
QZX is alpha software. Optional dependencies, permissions, and host capabilities can change the result.
Evidence workflow: requires an isolated disposable target.
Evidence and provenance
- Implementation
- src/qzx/commands/development/scaffold_python.py
- Tests
- No command-specific test file with the same module name was found; this does not prove that all coverage is absent.
- Documentation channel
- Development documentation 0.2.2.0.15 · main · sha256:b91acee86268edb7cb018a94e089ff8e95835eda3f2cf08b39796c0ab9654693
- Availability
- 0.2.2.0.15 or earlier
Keep exploring
Related commands
These commands also belong to the development category. Compare them to choose the operation that best fits your task.