Skip to main content

Build a Python CLI for your app, just using type hints and docstrings.

Project description

Logo

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


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.6.0.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

targ-0.6.0-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file targ-0.6.0.tar.gz.

File metadata

  • Download URL: targ-0.6.0.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for targ-0.6.0.tar.gz
Algorithm Hash digest
SHA256 4025476f1528eef963900295c2979b38ba28aadbd3668df9ae6677237b62a1d5
MD5 aff14567402a941c63ee623012ab5220
BLAKE2b-256 866d93cd8b2233c4040e2922ff77377ed33817f0370d603e0cc5c9a9c391adda

See more details on using hashes here.

File details

Details for the file targ-0.6.0-py3-none-any.whl.

File metadata

  • Download URL: targ-0.6.0-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for targ-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 75b83a49181d4758c2ef0caf345c8ced78156dee66613bab0a1a614e8e0ec7b6
MD5 f30f0c1e0f1e5aac6ec0c6ba6bf4f315
BLAKE2b-256 5490434ca23854e9d358f8562b51e688760bcc59a1d4be46a91aa37fd0f37d24

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page