Build a Python CLI for your app, just using type hints and docstrings.
Project description
targ
Build a Python CLI for your app, just using type hints and docstrings.
Just register your type annotated functions, and that's it - there's no special syntax to learn, and it's super easy.
# main.py
from targ import CLI
def add(a: int, b: int):
"""
Add the two numbers.
:param a:
The first number.
:param b:
The second number.
"""
print(a + b)
if __name__ == "__main__":
cli = CLI()
cli.register(add)
cli.run()
And from the command line:
>>> python main.py add 1 1
2
To get documentation:
>>> python main.py add --help
add
===
Add the two numbers.
Usage
-----
add a b
Args
----
a
The first number.
b
The second number.
Documentation
The full documentation is available on Read the Docs.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
targ-0.4.0.tar.gz
(9.5 kB
view details)
Built Distribution
targ-0.4.0-py3-none-any.whl
(7.2 kB
view details)
File details
Details for the file targ-0.4.0.tar.gz
.
File metadata
- Download URL: targ-0.4.0.tar.gz
- Upload date:
- Size: 9.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | dcdb57945bffe5bc59570d2e41bb1adc6280c5460332c5daf300729bc88d1aba |
|
MD5 | bedec241c46965e3d96d9a1af4d325fd |
|
BLAKE2b-256 | 138c8ab5d5391e36e27a67c6921f952a7c18d0b0ec19f4f8a88f0a64da81552d |
File details
Details for the file targ-0.4.0-py3-none-any.whl
.
File metadata
- Download URL: targ-0.4.0-py3-none-any.whl
- Upload date:
- Size: 7.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5237524323661ffa899158d668468b5c94bb84e2d988bd216981932844da63eb |
|
MD5 | 82081506aeb1bb66030d75f8b77f1bdb |
|
BLAKE2b-256 | 501e47625c6b3615035d3ef11da1edd6726e245610ed1cbb08d60acc939bd1ce |