compass.pipeline.data_classes.OutputSettings#

class OutputSettings(out_dir, log_dir=None, clean_dir=None, ordinance_file_dir=None, jurisdiction_dbs_dir=None, make_paths_relative=False)[source]#

Bases: object

Value Object for filesystem output settings

Parameters:

  • out_dir (path-like) – Path to the output directory. If it does not exist, it will be created. This directory will contain the saved collection manifest, downloaded ordinance documents, parsed document text, usage metadata, and default subdirectories for logs and intermediate outputs (unless otherwise specified).

  • log_dir (path-like, optional) – Path to the directory for storing log files. If not provided, a logs subdirectory will be created inside out_dir. By default, None.

  • clean_dir (path-like, optional) – Path to the directory for storing cleaned ordinance text output. If not provided, a cleaned_text subdirectory will be created inside out_dir. By default, None.

  • ordinance_file_dir (path-like, optional) – Path to the directory where downloaded ordinance files (PDFs or HTML) for each jurisdiction are stored. If not provided, a ordinance_files subdirectory will be created inside out_dir. By default, None.

  • jurisdiction_dbs_dir (path-like, optional) – Path to the directory where parsed ordinance database files are stored for each jurisdiction. If not provided, a jurisdiction_dbs subdirectory will be created inside out_dir. By default, None.

  • make_paths_relative (bool, default False) – Option to make all file paths in the saved collection manifest relative to the output directory. This can be helpful for sharing the manifest or for ensuring that it can be loaded correctly on a different machine. If False, absolute paths are used in the manifest. By default, True.

Methods

On this page