argyaml 0.1.0

Create a powerful and efficient CLI application using simple and user-friendly yaml config

Argyaml

Argyaml is a small module for creating powerful and scalable CLI applications based on a simple and user-friendly yaml configuration file.

Motivation

Argyaml is built over the argparse module, which is a part of python standard library starting python 3.2. While it works well for tiny projects that need to quickly access a few arguments and provide automatically generated help and usage messages for user, it gets very complicated and painful when it comes to large projects or your application grows in complexity.

Features

• Independent specification of CLI commands and arguments.
• No boilerplate code.
• Ability to set default options for commands, groups, and arguments.
• Automatic and optimized invocation of command handlers.
• Handler template files generator.

Install

# pip
pip install argyaml

# poetry
poetry add argyaml

Getting started

# cli-config.yaml
prog: todo
description: My beautiful todo app
next:
  - command: new
    next:
      - command: task
        description: Create a new task
        next:
          - argument: [name]
            help: the name of task
  - command: list
    next:
      - argument: [-t, --task]
        help: display tasks only
        action: 'store_true'

from argyaml import BaseHandler

base = BaseHandler()
base.args # <-- parsed and ready-to-use arguments

Learn more about config file.

Using Handlers

Generate template files using argyaml generate:

# pip
python -m argyaml generate

If you are using Poetry, add the following script to your pyproject.toml and then execute it using poetry run:

# pyproject.toml
[tool.poetry.scripts]
gen = "argyaml.__main__:generate"

# poetry
poetry run gen

This will generate the following files:

handlers/
  _new_task.py
  _list.py

Now, whenever new task command is called, the corresponding handler init function will be invoked with all additional aruments stored in the self.args object.

# _new_task.py
from argyaml import BaseHandler

class Handler(BaseHandler.meta()):
    def __init__(self):
        print(f"Successfully created task '{self.args['name']}'!")

Modify the main file to run the base handler:

from argyaml import BaseHandler

base = BaseHandler()
base.run()

Learn more about BaseHandler and argyaml generator.

Contributing

Feel free to open issues. Pull requests are welcome.

License

This project is licensed under the MIT License.