Skip to main content

vcs abstraction layer

Project description

``libvcs`` - abstraction layer for vcs, powers `vcspull`_.

|pypi| |docs| |build-status| |coverage| |license|

Install:

.. code-block:: sh

$ pip install libvcs

Open up python:

.. code-block:: sh

$ python

# or for nice autocomplete and syntax highlighting
$ pip install ptpython
$ ptpython

Create a `Repo`_ object of the project to inspect / checkout / update:

.. code-block:: python

>>> from libvcs.shortcuts import create_repo_from_pip_url, create_repo

# repo is an object representation of a vcs repository.
>>> r = create_repo(url='https://www.github.com/vcs-python/libtmux',
... vcs='git',
... repo_dir='/tmp/libtmux')

# or via pip-style URL
>>> r = create_repo_from_pip_url(
... pip_url='git+https://www.github.com/vcs-python/libtmux',
... repo_dir='/tmp/libtmux')

Update / clone repo:

.. code-block:: python

# it may or may not be checked out/cloned on the system yet
>>> r.update_repo()

Get revision:

.. code-block:: python

>>> r.get_revision()
u'5c227e6ab4aab44bf097da2e088b0ff947370ab8'

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 Python 2.7, >= 3.4, 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/en/latest/history.html
API https://libvcs.git-pull.com/en/latest/api.html
Issues https://github.com/vcs-python/libvcs/issues
Travis https://travis-ci.org/vcs-python/libvcs
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`_.
git repo .. code-block:: bash

$ git clone https://github.com/vcs-python/libvcs.git
install dev .. code-block:: bash

$ git clone https://github.com/vcs-python/libvcs.git libvcs
$ cd ./libvcs
$ virtualenv .venv
$ source .venv/bin/activate
$ pip install -e .
tests .. code-block:: bash

$ py.test
============== ==========================================================

.. _MIT: https://opensource.org/licenses/MIT
.. _Documentation: https://libvcs.git-pull.com/en/latest/
.. _API: https://libvcs.git-pull.com/en/latest/api.html
.. _pip: http://www.pip-installer.org/en/latest/
.. _vcspull: https://www.github.com/vcs-python/vcspull/
.. _Repo: https://libvcs.git-pull.com/en/latest/api.html#creating-a-repo-object

.. |pypi| image:: https://img.shields.io/pypi/v/libvcs.svg
:alt: Python Package
:target: http://badge.fury.io/py/libvcs

.. |build-status| image:: https://img.shields.io/travis/vcs-python/libvcs.svg
:alt: Build Status
:target: https://travis-ci.org/vcs-python/libvcs

.. |coverage| image:: https://codecov.io/gh/vcs-python/libvcs/branch/master/graph/badge.svg
:alt: Code Coverage
:target: https://codecov.io/gh/vcs-python/libvcs

.. |license| image:: https://img.shields.io/github/license/vcs-python/libvcs.svg
:alt: License

.. |docs| image:: https://readthedocs.org/projects/libvcs/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://readthedocs.org/projects/libvcs/

Project details


Release history Release notifications | RSS feed

This version

0.4.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

libvcs-0.4.1.tar.gz (20.6 kB view details)

Uploaded Source

File details

Details for the file libvcs-0.4.1.tar.gz.

File metadata

  • Download URL: libvcs-0.4.1.tar.gz
  • Upload date:
  • Size: 20.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.7.7

File hashes

Hashes for libvcs-0.4.1.tar.gz
Algorithm Hash digest
SHA256 c4f5b92a4d053067e759e8ef8b63531598bdd716d31fe7222af230f97aa56abc
MD5 9853bb11a327f1467346a1370ca52d93
BLAKE2b-256 48d6e2f747a6bfab88da35d5dd9f4f1779004f20fe5ebd988fc1b407ae24d86c

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page