vsgen.suite module

This module provides all functionality for VSGen’s suite functionality.

The module defines the class VSGSuite. The VSGSuite class groups a collection of solutions and projects into a single class.

class vsgen.suite.VSGSuite(config)

Bases: object

The VSGSuite class groups a collection of solutions and projects into a single class.

classmethod from_args(**kwargs)

Generates one or more VSGSuite instances from command line arguments.

Parameters:kwargs – List of additional keyworded arguments to be passed into the VSGSuite defined in the make_parser() method.

classmethod from_directory(directory, type, **kwargs)

Creates an VSGSuite instance from a filename.

Parameters:

• filename (str) – The fully qualified path to the VSG configuration file.
• type (str) – The configuration type to generate.
• kwargs – List of additional keyworded arguments to be passed into the VSGSuite.

classmethod from_file(filename)

Creates an VSGSuite instance from a filename.

Parameters:filename (str) – The fully qualified path to the VSG configuration file.

classmethod make_parser(**kwargs)

Creates a ArgumentParser instances to work with VSGSuite classes.

Parameters:kwargs – List of additional keyworded arguments to be passed into the ArgumentParser. Returns:A ArgumentParser instance.

write(parallel=True)

Writes the configuration to disk.