paramspecli 0.2.1__py3-none-any.whl

paramspecli-0.2.1.dist-info/METADATA

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: paramspecli
+Version: 0.2.1
+Summary: Type-safe facade for the venerable argparse
+Author: jkmnt
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+License-File: LICENSE
+Project-URL: Documentation, https://jkmnt.github.io/paramspecli
+Project-URL: Source, https://github.com/jkmnt/paramspecli
+
+# paramspecli
+
+**paramspecli** is a facade for the venerable [argparse](https://docs.python.org/3/library/argparse.html).
+It's simple, composable, and fun. But, most important, it's type-safe thanks to the [ParamSpec](https://docs.python.org/3/library/typing.html#typing.ParamSpec) magic.
+
+## Quick start
+
+```python
+from paramspecli import Command, argument, option, flag
+
+
+def ping(addr: str, *, until_stopped: bool, count: int | None):
+    print(f"Pinging {addr} ...")
+
+
+cli = Command(ping, prog="ping")
+cli.bind(
+    -argument("IP"),
+    until_stopped=-flag("-t"),
+    count=-option("-n", type=int),
+)
+
+result = cli.parse()
+result()
+```
+
+Running it:
+
+```
+$ python ping.py -t -n 10 127.0.0.1
+Pinging 127.0.0.1 ...
+```
+
+Type checker catches common errors:
+
+```python
+cli.bind(
+    # "bool" is not assignable to "str"
+    -argument("IP", type=bool),
+    # Type "bool | None" is not assignable to type "bool"
+    until_stopped=-flag("-t", default=None),
+    #
+    # Argument missing for parameter "count"
+)
+```
+
+IDE suggestions work too:
+
+<pre>
+cli.bind(⏎
+    <small>(<strong>addr: str</strong>, *, until_stopped: bool, count: int | None) -> None</small>
+</pre>
+
+## Installation
+
+```shell
+pip install paramspecli
+```
+
+## Key points
+
+**paramspecli** builds hierarchical CLIs with groups and commands.
+
+- Commands match handler functions parameters with arguments and options.
+- Arguments are bound to the handler's positional parameters.
+- Options are bound to the handler's keyword parameters.
+- Groups organize the commands. Groups may be nested. They could act like like an intermediate commands, i.e. have own handlers, options and arguments.
+- CLI 'compiles' to the `argparse`, runs it, then outputs the parse result.
+- Parse result is a callable. Calling it invokes handlers along the route.
+
+**paramspecli** supports several advanced `argparse` features: help sections, mutually exclusive
+options, options with the same destination. And adds a few own, like const options and passing contexts. It also includes a markdown documentation generator.
+
+[Read the documentation](https://jkmnt.github.io/paramspecli)

paramspecli-0.2.1.dist-info/RECORD

@@ -0,0 +1,16 @@
+paramspecli/__init__.py,sha256=etAehCcFInoM7XRh7-1QQfuq2ykL4anwDWhPVelnN6E,916
+paramspecli/apstub.py,sha256=9mKHRUZk9K1zKPpdsYAhOdxgVQSwmuow6og_4EZ2tJ0,2641
+paramspecli/args.py,sha256=Zypxg_JQiBsvC9oaijXNnvqtzRUZfR2D-RUpZGqrIbk,2442
+paramspecli/cli.py,sha256=bT1Y94LdqpaIYAG09Tni1f0SehfCFojDDE6_6KUUTeQ,31439
+paramspecli/conv.py,sha256=cTnL2LVyoy_5GAfEwlximA-hh_wX44NDXUykdWkm0yY,1959
+paramspecli/doc.py,sha256=na3p4C8mUERnoMHCxyjxLGZy5KYRw2uhbIzOFyeRKVw,11466
+paramspecli/fake.py,sha256=EiV825FY6gAor_NhLrPjeoUMzmVyXJH_3qDZp1AysFs,3400
+paramspecli/flags.py,sha256=Q8GPWnmCOmJ0sTZ1j3b4TAz7fx5MK34Bk0Y0iu8pKK4,5017
+paramspecli/md.py,sha256=jQEtQSTlagUKhTm3BCbl2bZeLDA30RLDl3c23EBwSHU,2125
+paramspecli/opts.py,sha256=ArvCN6dw8EfBJ8ZjAUNpoo2qBrnIppKZQFioiZB8wwM,8429
+paramspecli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+paramspecli/util.py,sha256=Byn68bnp97k6zK6H9KQRnheqwFMzZRdU3riig_W06d4,1382
+paramspecli-0.2.1.dist-info/licenses/LICENSE,sha256=CEcG7lAfbHe2yVPoacsWX5dA0PtygQcuhHv6MqNI0PM,1062
+paramspecli-0.2.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+paramspecli-0.2.1.dist-info/METADATA,sha256=mR00CyujFGja8EDCp7Z2ar91CIt9ti_g2uvXVyWzOgw,2594
+paramspecli-0.2.1.dist-info/RECORD,,

paramspecli-0.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

paramspecli-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 jkmnt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.