Skip to content

README.md

Latest commit

 

History

History
38 lines (27 loc) · 1.06 KB

README.md

File metadata and controls

38 lines (27 loc) · 1.06 KB
Raw

Python CLI example

Generate a small Python command-line application with package metadata, a Click-based CLI, tests, and contributor-friendly docs.

Use case

Use this when you want a quick starting point for an internal automation CLI, developer tool, or small Python utility.

Command

structkit generate --vars "project_name=DemoCLI,package_name=demo_cli,cli_command=demo-cli,description=A small Python CLI generated by StructKit." examples/python-cli/.struct.yaml ./demo-python-cli

Optional custom values:

structkit generate \
  --var project_name=ReleaseHelper \
  --var package_name=release_helper \
  --var cli_command=release-helper \
  examples/python-cli/.struct.yaml \
  ./release-helper

Expected output

  • README.md
  • pyproject.toml
  • src/<package_name>/__init__.py
  • src/<package_name>/cli.py
  • tests/test_cli.py
  • .gitignore

Customization notes

  • Change cli_command to control the installed console script name.
  • Add runtime dependencies in pyproject.toml once the generated project grows beyond the starter CLI.