YadOpt Documentation
Overview
This documentation provides a comprehensive guide to YadOpt, a help-message-driven command-line argument parsing library for Python. YadOpt treats a human-readable help message as the single source of truth for defining CLI behavior. From this specification, it automatically derives parsing logic, typed interfaces, and reproducible configurations.
For basic information of YadOpt, including installation instructions and quick examples, please refer to the README of the repository. This documentation focuses on the detailed information, such as the API reference and the help message specification, avoiding duplication of introductory materials.
Table of Contents
Help Message Specification
- Overview of help message structure
- Sections
- Lines in a section
- Positional argument declaration
- Optional argument declaration
- Naming conventions
- Type inference of positional or optional argument values
- Common mistakes and pitfalls
API Reference
- yadopt.parse
- yadopt.wrap
- yadopt.save
- yadopt.load
- yadopt.to_dict
- yadopt.to_namedtuple
- yadopt.get_group
Miscellaneous
Project Information
Author
YadOpt is developed and maintained by:
Contributing and Issues
Bug reports, feature requests, and contributions are welcome. Please visit the GitHub repository:
License
This project is distributed under the MIT License.
Acknowledgements
YadOpt is inspired by projects such as docopt and docopt-ng aims to extend the idea of help-message-driven CLI definitions for modern Python development.