pyp2qmd Configuration

Description

Custom class for handling the required arguments for pyp2qmd which has two modes: If argparse = False (default) on initialization, the user must use the :py:meth:setup method to specify the required arguments.

If argparse = True user inputs will be parsed via the argparse package and automatically handed over to the :py:meth:setup method. This is used when called via console (console arguments).

Usage

Config(argparse=False)

Arguments

argparsebool

False by default, the user has to use the .setup() method. If set to True it will try to parse input arguments via argparse.

Methods

Config.get(what)

Get Attribute

Config.is_set_up()

Object Set Up Properly?

Config.setup(action, package, quarto_dir='_quarto', man_dir='man', output_dir='_site', overwrite=False, include_hidden=False,
examples_dir='_examples', docstringstyle='GOOGLE', silent=False)

Config Setup