# API Reference

This page documents the Python API for wcheck. You can use these functions programmatically in your own scripts.

## Core Functions

::: wcheck.wcheck.check_workspace_status
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.compare_workspace_to_config
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.compare_config_files
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.compare_config_versions
    options:
      show_root_heading: true
      heading_level: 3

## Utility Functions

::: wcheck.wcheck.get_workspace_repos
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.get_status_repo
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.get_repo_head_ref
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.get_remote_status
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.get_elapsed_time_repo
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.show_repos_config_versions
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.matches_any
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.wcheck.fetch_all
    options:
      show_root_heading: true
      heading_level: 3

## GUI Module

::: wcheck.gui.show_gui
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.gui.WCheckGUI
    options:
      show_root_heading: true
      heading_level: 3

::: wcheck.gui.RepoObject
    options:
      show_root_heading: true
      heading_level: 3
