Skip to content

distribution.md

Latest commit

 

History

History
92 lines (67 loc) · 2.06 KB

distribution.md

File metadata and controls

92 lines (67 loc) · 2.06 KB

Distribution

KOMU CLI now has the structure expected from a public Python CLI repository:

  • pyproject.toml build metadata
  • console entrypoint via komu
  • src/ layout
  • package data for playbooks
  • typed distribution marker via py.typed
  • wheel/sdist-ready build configuration

Current package shape

  • distribution name: komu-cli
  • import package: komu_cli
  • console command: komu
  • module entrypoint: python -m komu_cli

Local release build

python -m pip install -e .[release]
python -m build

Artifacts will be created in dist/.

Local installation checks

From a built wheel:

pipx install ./dist/komu_cli-0.1.0-py3-none-any.whl
komu --help

Or:

python -m pip install ./dist/komu_cli-0.1.0-py3-none-any.whl
komu --help

PyPI readiness

The repository is close to PyPI-ready, but a few publication tasks remain outside normal code changes:

  1. set the final repository and homepage URLs in pyproject.toml
  2. decide and document the release workflow
  3. publish release artifacts from CI or a controlled maintainer machine
  4. validate install flows on clean Windows and Linux/macOS environments
  5. validate provider configuration flows for:
    • local Ollama
    • OpenAI-compatible gateways
    • Claude
    • OpenAI
    • Gemini
  6. optionally add twine check and publish automation in CI

Future publish flow

Typical future steps:

python -m pip install -e .[release]
python -m build
python -m twine check dist/*
python -m twine upload dist/*

Once published, users should be able to install with:

pip install komu-cli
pipx install komu-cli

Why pipx matters

KOMU is a user-facing CLI, not just a library. That makes pipx an especially strong distribution path because it:

  • isolates CLI dependencies
  • avoids requiring a project venv
  • exposes the komu command cleanly
  • maps well to GitHub and PyPI installs

Related docs