libvcs._internal.shortcuts

Shortcuts for creating projects.

Note

This is an internal API not covered by versioning policy.

libvcs._internal.shortcuts.create_project(url: str, vcs: Literal[git], progress_callback: Optional[libvcs._internal.run.ProgressCallbackProtocol] = None, *args, **kwargs)

Return an object representation of a VCS repository.

Examples

>>> from libvcs._internal.shortcuts import create_project
>>> r = create_project(
...     url=f'file://{create_git_remote_repo()}',
...     vcs='git',
...     dir=tmp_path
... )

>>> isinstance(r, GitProject)
True