API Reference

See also

For granular control see libvcs’s Commands and Projects.

Internals

Warning

Be careful with these! Internal APIs are not covered by version policies. They can break or be removed between minor versions!

If you need an internal API stabilized please file an issue.

• Config - vcspull.config
  • expand_dir()
  • extract_repos()
  • find_home_config_files()
  • find_config_files()
  • load_configs()
  • detect_duplicate_repos()
  • in_dir()
  • filter_repos()
  • is_config_file()
  • save_config_yaml()
  • canonicalize_workspace_path()
  • workspace_root_label()
  • normalize_workspace_roots()
• CLI
  • vcspull sync - vcspull.cli.sync
    • SyncPlanConfig
      • fetch
      • offline
    • _visible_length()
    • PlanProgressPrinter
      • update()
      • finish()
    • _extract_repo_url()
    • _get_repo_path()
    • clamp()
    • _maybe_fetch()
    • _determine_plan_action()
    • _update_summary()
    • _build_plan_entry()
    • _build_plan_result_async()
    • _filter_entries_for_display()
    • _format_detail_text()
    • _render_plan()
    • _emit_plan_output()
    • create_sync_subparser()
    • sync()
    • progress_cb()
    • guess_vcs()
    • CouldNotGuessVCSFromURL
    • update_repo()
  • vcspull add - vcspull.cli.add
    • create_add_subparser()
    • _resolve_workspace_path()
    • add_repo()
  • vcspull discover - vcspull.cli.discover
    • get_git_origin_url()
    • create_discover_subparser()
    • _resolve_workspace_path()
    • discover_repos()
  • vcspull list - vcspull.cli.list
    • create_list_subparser()
    • list_repos()
    • _output_flat()
    • _output_tree()
  • vcspull status - vcspull.cli.status
    • StatusCheckConfig
      • max_concurrent
      • detailed
    • _visible_length()
    • StatusProgressPrinter
      • __init__()
      • update()
      • finish()
    • create_status_subparser()
    • _check_repos_status_async()
    • _run_git_command()
    • check_repo_status()
    • status_repos()
    • _format_status_line()
  • vcspull fmt - vcspull.cli.fmt
    • create_fmt_subparser()
    • normalize_repo_config()
    • format_config()
    • format_single_config()
    • format_config_file()
  • vcspull CLI - vcspull.cli
    • build_description()
    • create_parser()
    • cli()
• Exceptions - vcspull.exc
  • VCSPullException
  • MultipleConfigWarning
    • message
• Logging - vcspull.log
  • get_cli_logger_names()
  • setup_logger()
  • LogFormatter
    • template()
    • format()
  • DebugLogFormatter
    • template()
  • RepoLogFormatter
    • template()
  • SimpleLogFormatter
    • format()
  • RepoFilter
    • filter()
• Internals
  • Config reader - vcspull._internal.config_reader
    • ConfigReader
      • _load()
      • load()
      • _from_file()
      • from_file()
      • _dump()
      • dump()
• Validation - vcspull.validator
  • is_valid_config()
• Utilities - vcspull.util
  • get_config_dir()
  • contract_user_home()
  • update_dict()
• Typings - vcspull.types
  • Configuration Object Graph
  • RawConfigDict
    • vcs
    • name
    • path
    • url
    • remotes
  • ConfigDict
    • vcs
    • name
    • path
    • url
    • workspace_root
    • remotes
    • shell_command_after