Lite, typed, python utilities for Git, SVN, Mercurial, etc.
Project description
libvcs · 
libvcs is a lite, typed, pythonic tool box for
detection and parsing of URLs, commanding, and syncing with git, hg, and svn. Powers
vcspull.
Overview
Supports Python 3.9 and above
Features for Git, Subversion, and Mercurial:
- Detect and parse VCS URLs
- Command VCS via python API
- Sync repos locally
- Test fixtures for temporary local repos and working copies
To get started, see the quickstart for more.
$ pip install --user libvcs
URL Parser
You can validate and parse Git, Mercurial, and Subversion URLs through
libvcs.url:
Validate:
>>> from libvcs.url.git import GitURL
>>> GitURL.is_valid(url='https://github.com/vcs-python/libvcs.git')
True
Parse and adjust a Git URL:
>>> from libvcs.url.git import GitURL
>>> git_location = GitURL(url='git@github.com:vcs-python/libvcs.git')
>>> git_location
GitURL(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:
>>> from libvcs.url.git import GitURL
>>> 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 the parser document.
Commands
Simple subprocess wrappers around git(1),
hg(1), svn(1). Here is Git w/
Git.clone:
import pathlib
from libvcs.cmd.git import Git
git = Git(dir=pathlib.Path.cwd() / 'my_git_repo')
git.clone(url='https://github.com/vcs-python/libvcs.git')
Sync
Create a GitSync
object of the project to inspect / checkout / update:
import pathlib
from libvcs.sync.git import GitSync
repo = GitSync(
url="https://github.com/vcs-python/libvcs",
dir=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'
Pytest plugin
libvcs also provides a test rig for local repositories. It automatically can provide clean local repositories and working copies for git, svn, and mercurial. They are automatically cleaned up after each test.
It works by bootstrapping a temporary $HOME environment in a
TmpPathFactory
for automatic cleanup.
import pathlib
from libvcs.pytest_plugin import CreateProjectCallbackFixtureProtocol
from libvcs.sync.git import GitSync
def test_repo_git_remote_checkout(
create_git_remote_repo: CreateProjectCallbackFixtureProtocol,
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(dir=str(git_repo_checkout_dir), url=f"file://{git_server!s}")
git_repo.obtain()
git_repo.update_repo()
assert git_repo.get_revision() == "initial"
assert git_repo_checkout_dir.exists()
assert pathlib.Path(git_repo_checkout_dir / ".git").exists()
Learn more on the docs at https://libvcs.git-pull.com/pytest-plugin.html
Donations
Your donations fund development of new features, testing and support. Your money will go directly to maintenance and development of the project. If you are an individual, feel free to give whatever feels right for the value you get out of the project.
See donation options at https://www.git-pull.com/support.html.
More information
- Python support: 3.9+, pypy
- VCS supported: git(1), svn(1), hg(1)
- Source: https://github.com/vcs-python/libvcs
- Docs: https://libvcs.git-pull.com
- Changelog: https://libvcs.git-pull.com/history.html
- APIs for git, hg, and svn:
libvcs.url: URL Parserlibvcs.cmd: Commandslibvcs.sync: Clone and update
- Issues: https://github.com/vcs-python/libvcs/issues
- Test Coverage: https://codecov.io/gh/vcs-python/libvcs
- pypi: https://pypi-hypernode.com/pypi/libvcs
- Open Hub: https://www.openhub.net/p/libvcs
- License: MIT.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file libvcs-0.21.2.tar.gz.
File metadata
- Download URL: libvcs-0.21.2.tar.gz
- Upload date:
- Size: 70.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d72654b66ed094681b8f01f6623d5bb1c61fb89e583ab50f45c4a8aa2a989e1c |
|
| MD5 | b5d6b12e2e82f3975832772bcfb6a1d5 |
|
| BLAKE2b-256 | 82b4322f00e0bac8127af004f8dd14473c0f9fa976f9aa77de26a8443f33a057 |
Provenance
File details
Details for the file libvcs-0.21.2-py3-none-any.whl.
File metadata
- Download URL: libvcs-0.21.2-py3-none-any.whl
- Upload date:
- Size: 70.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.1 CPython/3.11.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c045053e90d3f135223c6724cc059b0824e5e47f19cc5639c2f5c1deca9cf02c |
|
| MD5 | a02ef8f66c9b9aff9f5291472ef8bad3 |
|
| BLAKE2b-256 | 33dafc37853a48383b5b69493062f1cfa9b06b58b7a2fe7f4350c6661dbabcc9 |
