Skip to content

index.md

Latest commit

 

History

History
55 lines (42 loc) · 1.08 KB

index.md

File metadata and controls

55 lines (42 loc) · 1.08 KB

(api)=

(reference)=

API Reference

libvcs exposes three public subsystems -- URL parsing, command execution, and repository synchronization -- plus a pytest plugin for test fixtures.

All APIs are pre-1.0 and may change between minor versions. Pin to a range: libvcs>=0.39,<0.40.

Subsystems

::::{grid} 1 1 2 2 :gutter: 2 2 3 3

:::{grid-item-card} URL Parsing :link: /url/index :link-type: doc Detect, validate, and normalize Git / Hg / SVN URLs. Typed dataclasses with pip- and npm-style support. :::

:::{grid-item-card} Commands :link: /cmd/index :link-type: doc Thin Python wrappers around git, hg, and svn CLIs. Fine-grained control over individual VCS operations. :::

:::{grid-item-card} Sync :link: /sync/index :link-type: doc High-level clone-and-update for local repositories. One call to fetch or create a working copy. :::

:::{grid-item-card} pytest Plugin :link: api/pytest-plugin :link-type: doc Session-scoped fixtures for Git, SVN, and Mercurial repositories. Drop-in test isolation. :::

::::

:hidden:

/url/index
/cmd/index
/sync/index
pytest-plugin