scripts¶
scripts.__init__¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | No module description available. |
| Args | — |
| Returns | — |
scripts.dev_commit¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | No module description available. |
| Args | — |
| Returns | — |
🛠️ Functions¶
get_current_branch¶
Returns the name of the current Git branch. Returns: str
get_modified_files¶
Returns a list of files modified (but not yet committed) in the current Git working directory. Returns: list[str]
is_valid_branch_name¶
Checks if the provided branch name is valid according to Git naming conventions. Parameters: ['name: str'] Returns: bool
generate_suggested_branch_name¶
Generates a suggested branch name based on modified files and the current date. Returns: str
switch_to_new_branch¶
Prompts the user to create and switch to a new Git branch. Suggests a branch name based on modified files and validates user input. Exits the script if the branch name is invalid or if Git fails to create or push the branch. Returns: None
scripts.main¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | main.py |
| This module provides the entrypoint for the Zephyrus Logger application. | |
| It initializes the logging system, loads the application configuration, and | |
| sets up the GUI or CLI depending on the mode specified in the configuration. | |
| Key features include: | |
| - Logging setup | |
| - Config loading | |
| - GUI or CLI setup | |
| - Controller and GUI instance initialization | |
| This is the main entrypoint for the Zephyrus Logger application. | |
| Args | — |
| Returns | — |
🛠️ Functions¶
bootstrap¶
Bootstraps the Zephyrus Logger application. Parameters: ['start_gui: bool'] Returns: tuple[GUIController, ZephyrusLoggerGUI | None]
scripts.paths¶
🧠 Docstring Summary
| Section | Content |
|---|---|
| Description | No module description available. |
| Args | — |
| Returns | — |
📦 Classes¶
ZephyrusPaths¶
Dataclass for managing and resolving all Zephyrus project file and directory paths. Provides methods to construct absolute paths for logs, exports, configuration, and vector store files, with support for test mode path overrides based on the loaded configuration. Returns: None
🛠️ Functions¶
_resolve_path¶
Resolve an absolute Path for a given config key, falling back to the provided default if the key is missing. Parameters: ['config: Any', 'key: Any', 'default: Any'] Returns: Path
from_config¶
Constructs a ZephyrusPaths instance by resolving all required file and directory paths from the loaded configuration. Automatically applies test mode path overrides if enabled. Parameters: ['script_dir: Path'] Returns: 'ZephyrusPaths'