usage-spec
Core types and rendering for usage spec.
Install
pip install usage-spec
API
Types
@dataclass
class Spec:
name: str
bin: str
version: str
about: str
long: str
usage: str
flags: list[SpecFlag]
args: list[SpecArg]
cmds: list[SpecCommand]
Functions
from usage_spec import generate, render_kdl, render_json, validate_kdl
# Render Spec as KDL string
render_kdl(spec: Spec) -> str
# Render Spec as JSON string
render_json(spec: Spec) -> str
# Generate spec output with optional format and comment
generate(spec: Spec, format: str = "kdl", comment: str | None = None) -> str
# Validate KDL string by basic structural check
validate_kdl(kdl: str) -> None
License
MIT
Metadata
Release files for usage-spec 1.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| usage_spec-1.2.0.tar.gz | 5.2 kB | Without provenance | Details for usage_spec-1.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| usage_spec-1.2.0-py3-none-any.whl | Python 3 | none | any | Details for usage_spec-1.2.0-py3-none-any.whl |
Total release size: 10.0 kB
Release files / usage_spec-1.2.0.tar.gz
| Download URL | usage_spec-1.2.0.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0cb27581d79e0c3299c956642957e724838dad3ba9faeb7164a5a1e6daf7b30a
|
|
BLAKE2b-256 checksum How to use checksums |
c49803cee6cd613da11ef56b828bcb26d03d5e8abeba4ae16c897cbb91621f77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.14
|
Release files / usage_spec-1.2.0-py3-none-any.whl
| Download URL | usage_spec-1.2.0-py3-none-any.whl |
|---|---|
| Size | 4.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7df71345ce2de0547ff145b53d3a14f7336bb2728784beff1ea8f728f192a78c
|
|
BLAKE2b-256 checksum How to use checksums |
f7471a4c3f9093fb28e6d0586fb2f7502f02d1d77d0c80508ffb206542327668
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.7.14
|
Security for usage-spec 1.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.