Shortcuts - libvcs._internal.shortcuts

Shortcuts for creating repos.

Note

This is an internal API not covered by versioning policy.

exception libvcs._internal.shortcuts.VCSNoMatchFoundForUrl(url, *args)

Bases: LibVCSException

Parameters:

• url (str)

• args (object)

Return type:

None

exception libvcs._internal.shortcuts.VCSMultipleMatchFoundForUrl(url, *args)

Bases: LibVCSException

Parameters:

• url (str)

• args (object)

Return type:

None

exception libvcs._internal.shortcuts.VCSNotSupported(url, vcs, *args)

Bases: LibVCSException

Parameters:

• url (str)

• vcs (str)

• args (object)

Return type:

None

libvcs._internal.shortcuts.create_project(*, url, path, vcs=None, progress_callback=None, **kwargs)

Return an object representation of a VCS repository.

Return type:

GitSync | HgSync | SvnSync

Parameters:

• url (str)

• path (StrPath)

• vcs (VCSLiteral | None)

• progress_callback (ProgressCallbackProtocol | None)

• kwargs (dict[t.Any, t.Any])

Examples

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

>>> isinstance(r, GitSync) True 

create_project can also guess VCS for certain URLs:

>>> r = create_project( ...  # Note the git+ before the URL ...  url=f'git+file://{create_git_remote_repo()}', ...  path=tmp_path ... ) 

>>> isinstance(r, GitSync) True 

It also supports unprefixed SSH-style Git URLs:

>>> r = create_project( ...  url='[email protected]:tmux-python/tmuxp.git', ...  path=tmp_path ... ) >>> isinstance(r, GitSync) True