Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

⚙️ Lite, typed, pythonic utilities for git, svn, mercurial, etc.

License

NotificationsYou must be signed in to change notification settings

vcs-python/libvcs

Repository files navigation

libvcs is a lite,typed, pythonic tool box fordetection and parsing of URLs, commanding, and syncing withgit,hg, andsvn. Powersvcspull.

Overview

Key Features

  • URL Detection and Parsing: Validate and parse Git, Mercurial, and Subversion URLs.
  • Command Abstraction: Interact with VCS systems through a Python API.
  • Repository Synchronization: Clone and update repositories locally viaPython API.
  • py.test fixtures: Create temporary local repositories and working copies for testing for unit tests.

Supports Python 3.10 and above, Git (including AWS CodeCommit), Subversion, and Mercurial.

Toget started, see thequickstart guide for more information.

$pip install --user libvcs

URL Detection and Parsing

Easily validate and parse VCS URLs using thelibvcs.url module:

Validate URLs

>>>fromlibvcs.url.gitimportGitURL>>>GitURL.is_valid(url='https://github.com/vcs-python/libvcs.git')True

Parse and adjust Git URLs:

>>>fromlibvcs.url.gitimportGitURL>>>git_location=GitURL(url='git@github.com:vcs-python/libvcs.git')>>>git_locationGitURL(url=git@github.com:vcs-python/libvcs.git,user=git,hostname=github.com,path=vcs-python/libvcs,suffix=.git,rule=core-git-scp)

Switch repo libvcs -> vcspull:

>>>fromlibvcs.url.gitimportGitURL>>>git_location=GitURL(url='git@github.com:vcs-python/libvcs.git')>>>git_location.path='vcs-python/vcspull'>>>git_location.to_url()'git@github.com:vcs-python/vcspull.git'# Switch them to gitlab:>>>git_location.hostname='gitlab.com'# Export to a `git clone` compatible URL.>>>git_location.to_url()'git@gitlab.com:vcs-python/vcspull.git'

See more in theparser document.

Command Abstraction

Abstracts CLI commands forgit(1),hg(1),svn(1) via a lightweightsubprocess wrapper.

Run Git Commands

importpathlibfromlibvcs.cmd.gitimportGitgit=Git(path=pathlib.Path.cwd()/'my_git_repo')git.clone(url='https://github.com/vcs-python/libvcs.git')

Above:libvcs.cmd.git.Git usingGit.clone().

Repository Synchronization

Synchronize your repositories using thelibvcs.sync module.

Clone and Update Repositories

importpathlibfromlibvcs.sync.gitimportGitSyncrepo=GitSync(url="https://github.com/vcs-python/libvcs",path=pathlib.Path().cwd()/"my_repo",remotes={'gitlab':'https://gitlab.com/vcs-python/libvcs'   })# Update / clone repo:>>>repo.update_repo()# Get revision:>>>repo.get_revision()u'5c227e6ab4aab44bf097da2e088b0ff947370ab8'

Above:libvcs.sync.git.GitSync repositoryobject usingGitSync.update_repo()andGitSync.get_revision().

Pytest plugin: Temporary VCS repositories for testing

libvcspytest plugin providespy.test fixtures to swiftly create local VCS repositories and working repositories to test with. Repositories are automatically cleaned on test teardown.

Use temporary, local VCS in py.test

importpathlibfromlibvcs.pytest_pluginimportCreateRepoPytestFixtureFnfromlibvcs.sync.gitimportGitSyncdeftest_repo_git_remote_checkout(create_git_remote_repo:CreateRepoPytestFixtureFn,tmp_path:pathlib.Path,projects_path:pathlib.Path,)->None:git_server=create_git_remote_repo()git_repo_checkout_dir=projects_path/"my_git_checkout"git_repo=GitSync(path=str(git_repo_checkout_dir),url=f"file://{git_server!s}")git_repo.obtain()git_repo.update_repo()assertgit_repo.get_revision()=="initial"assertgit_repo_checkout_dir.exists()assertpathlib.Path(git_repo_checkout_dir/".git").exists()

Under the hood: fixtures bootstrap a temporary$HOME environment in aTmpPathFactoryfor automatic cleanup andpytest-xdist compatibility..

Donations

Your donations fund development of new features, testing and support. Your money will go directly tomaintenance and development of the project. If you are an individual, feel free to give whateverfeels right for the value you get out of the project.

See donation options athttps://tony.sh/support.html.

More information

DocsBuild Status

About

⚙️ Lite, typed, pythonic utilities for git, svn, mercurial, etc.

Topics

Resources

License

Stars

Watchers

Forks

Contributors8

Languages

[8]ページ先頭
©2009-2025 Movatter.jp