Skip to content

Latest commit

 

History

History
141 lines (91 loc) · 4.07 KB

README.md

File metadata and controls

141 lines (91 loc) · 4.07 KB
Raw

drawing

PyArgWriter

Coverage Status PyPI - Python Version

PyArgWriter is a Python module that simplifies the generation of ArgumentParser setups for Python classes and their methods. It provides a convenient way to define and manage command-line arguments for your Python applications.

Installation

You can install PyArgWriter using pip:

pip install pyargwriter

Alternative from source code:

In root folder with pip:

pip install .

or with poetry:

poetry install

Command-Line Interface

PyArgWriter offers the following command-line commands:

  • parse-code: Parse given files and create YAML structure with structural parser information.
  • write-code: Read given parser YAML structure and create argument parser Python code.
  • generate-argparser: Generate parser.py, which contains a setup_parser function to set up an appropriate parser.

For more detailed information on available command-line arguments and usage examples, refer to the official documentation.

Requirements

PyArgWriter depends strongly on information stated in the docstring. Your docstring should have ha minimal structure like:

def add(a: int, b: int) -> int:
    """_summary_

    Args:
        a (int): _description_
        b (int): _description_

    Returns:
        int: _description_
    """
    return a + b

Usage

Usage PyArgWriter offers a command-line interface for generating and managing ArgumentParser setups. Below are the available commands and their usage:

parse-code

python -m pyargwriter parse-code --input file1.py file2.py --output output.yaml [--log-level LOG_LEVEL]

Parse given Python files and create a YAML structure with structural parser information.

write-code

python -m pyargwriter write-code --input input.yaml [--output OUTPUT_DIR] [--pretty] [--log-level LOG_LEVEL]

Read a given parser YAML structure and generate argument parser Python code.

generate-argparser

python -m pyargwriter generate-argparser --input file1.py file2.py [--output OUTPUT_DIR] [--pretty] [--log-level LOG_LEVEL]

Generate a parser.py file that contains a setup_parser function to set up an appropriate ArgumentParser. Common Options --log-level LOG_LEVEL: Sets the log level for command execution (default is "WARN"). --pretty (-p): If set, the generated code will be formatted with Black. For more detailed information on each command and additional options, run:

python -m pyargwriter <command> --help

Supported Argument Types

In the function of the process class you want to create the argument parser, following types of an argument are supported:

  • int
  • float
  • str
  • bool flags
  • list[int]
  • List[int] # from typing
  • list[float]
  • List[float] # from typing
  • list[str]
  • List[str] # from typing
  • list[bool]
  • List[bool] # from typing

Example

python -m pyargwriter generate-argparser --input examples/shopping.py examples/car.py --output examples --pretty

Documentation

The complete documentation for PyArgWriter, including detailed usage instructions and examples, can be found in the official documentation or at the documentation website.

Further you can have a look into the test coverage.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.

Contributing

If you would like to contribute to PyArgWriter, please read our Contributing Guidelines for details on how to get started.

Contact

For any questions, issues, or feedback, please open an issue on our GitHub repository.