Skip to content

README.md

Latest commit

 

History

History
60 lines (39 loc) · 1.59 KB

README.md

File metadata and controls

60 lines (39 loc) · 1.59 KB
Raw

uploadkit-cli

CI Python

Developer CLI for UploadKit validation, inspection, and upload simulation.

What problem does this solve?

A local debug surface for composing Core + security + feature-package validators without writing app code.

When to use it

Use during development and CI to lint fixture uploads.

When not to use it

  • Do not expose framework HTTP APIs here.
  • Do not use as a production upload gateway.

Installation

pip install uploadkit-cli

# Optional feature packages
pip install 'uploadkit-cli[pdf,office,audio]'
# or
pip install 'uploadkit-cli[all]'

Commands

uploadkit validate path/to/file.pdf -e pdf
uploadkit inspect path/to/file.docx
uploadkit simulate path/to/file.wav --policy audio --json
uploadkit policies list
uploadkit doctor

Exit code 1 on validation failure (CI-friendly with --json).

Coverage

No coverage badge yet. CI runs pytest without a coverage gate, and current smoke tests leave many CLI branches unexercised (missing optional extras, inspect error paths, flag variants) — about 65% when measured locally.

A coverage badge will be added once CI enforces a gate. Unlike Core / framework adapters, this package does not claim 100% coverage.

Changelog

See CHANGELOG.md.

Contributing

See CONTRIBUTING.md.