srcalchemy¶
External Functions¶
Internal Functions¶
- srcalchemy.srcalchemy.collectConfig(config_path: str = 'config.ini') ConfigSpec[source]¶
Parse Configuration from file. If file does not exist returns default configuration
- Parameters:
config_path – Path to configuration file
- Returns:
Populated configuration
- srcalchemy.srcalchemy.configLogger(level: str, log_file: str | None = None, log_std: bool = False) Logger[source]¶
Configure logging object
- Parameters:
level – String representation of log level
log_file – Path to log file
log_std – If True output log to standard output
- Returns:
Logging Object
- srcalchemy.srcalchemy.parseArgs(config_data: ConfigSpec) tuple[Namespace, ConfigSpec][source]¶
Parse command line arguments
- Params config_data:
Configuration data, will be modified and returned
- Returns:
Tuple containing parsed arguments and modified configuration information
- srcalchemy.srcalchemy.init(config_path: str = 'config.ini') int[source]¶
Write default configuration to file
- Parameters:
config_path – Path to configuration file
- Returns:
Status Code
- srcalchemy.srcalchemy.collect(config_data: ConfigSpec) int[source]¶
Collect Move and TV information and serialize
- Parameters:
config – Configuration object
- Returns:
Status Code
- srcalchemy.srcalchemy.rename(config_data: ConfigSpec, dry_run: bool = False) int[source]¶
Perform rename operations from serialized data
- Parameters:
config – Configuration object
dry_run – If True, will perform as dry run of rename operation
- Returns:
Status Code
- srcalchemy.srcalchemy.clean(config_data: ConfigSpec, dry_run: bool = False) int[source]¶
Perform clean operation
- Parameters:
config – Configuration object
dry_run – If True, will perform as dry run of clean operation
- Returns:
Status Code