https://github.com/piccolo-orm/targ
Python CLI using type hints and docstrings.
https://github.com/piccolo-orm/targ
cli docstrings hacktoberfest python typehints
Last synced: 5 months ago
JSON representation
Python CLI using type hints and docstrings.
- Host: GitHub
- URL: https://github.com/piccolo-orm/targ
- Owner: piccolo-orm
- License: mit
- Created: 2020-04-18T15:29:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-07-15T20:04:07.000Z (over 1 year ago)
- Last Synced: 2025-01-09T02:38:59.021Z (about 1 year ago)
- Topics: cli, docstrings, hacktoberfest, python, typehints
- Language: Python
- Homepage: https://targ.readthedocs.io/en/latest/index.html
- Size: 120 KB
- Stars: 20
- Watchers: 3
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
README
# 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.
```python
# 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:
```bash
>>> python main.py add 1 1
2
```
To get documentation:
```bash
>>> 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](https://targ.readthedocs.io/en/latest/index.html).