Config Classes (cfgclasses)

User Guide:

• Getting Started
  • Installation
  • A simple application
  • Common patterns

API Reference

If you are looking for information on a specific function, class or method, this part of the documentation is for you.

API Reference:

• API
• cfgclasses
  • parse_args()
  • parse_args_with_submodes()
  • parse_known_args()
  • parse_known_args_with_submodes()
  • arg()
  • optional()
  • CFG_METADATA_FIELD
  • ConfigOpts
  • NonPositionalConfigOpts
  • cfgtransform()
  • ConfigClassTransform
  • mutually_exclusive()
  • validator()
  • cfgclasses.transforms

Further Information

The following documentation pages are available and cover topics that are not expected to be of general interest to users, but are provided as internal and external references.

Further Information:

• Design
  • 1. Problem Definition
  • 2. Design Overview
  • Additional Feature Designs
• Contributing
• Create a virtual environment
• Running the tests
• Run the formatters linters
• Build the documentation
• Building the package for deployment