Metadata-Version: 1.0
Name: gitsubrepo
Version: 1.0.2
Summary: Provides access to `git subrepo` in Python
Home-page: https://github.com/wtsi-hgi/python-git-subrepo-wrapper
Author: UNKNOWN
Author-email: UNKNOWN
License: MIT
Description: |Build Status| |codecov| |PyPI version|
        
        Git Subrepo Python Wrapper
        ==========================
        
        In the same way that
        ```GitPython`` <https://pypi.python.org/pypi/GitPython/>`__ wraps
        ``git``, this library provides easy access to `git
        subrepo <https://github.com/ingydotnet/git-subrepo>`__ in Python.
        
        How to use
        ----------
        
        Prerequisites
        ~~~~~~~~~~~~~
        
        -  git >= 2.10.0 (on path)
        -  git-subrepo >= 0.3.1
        -  python >= 3.6
        
        Installation
        ~~~~~~~~~~~~
        
        Stable releases can be installed via
        `PyPI <https://pypi.python.org/pypi/gitsubrepo>`__:
        
        .. code:: bash
        
            $ pip install gitsubrepo
        
        Bleeding edge versions can be installed directly from GitHub:
        
        .. code:: bash
        
            $ pip install git+https://github.com/wtsi-hgi/python-git-subrepo-wrapper.git@${commit_id_or_branch_or_tag}#egg=gitsubrepo
        
        To declare this library as a dependency of your project, add it to your
        ``requirement.txt`` file.
        
        API
        ~~~
        
        The library currently supports 3 ``git subrepo`` operations: ``clone``,
        ``pull`` and ``status``. Please see the documentation for specific
        information on how to use these methods.
        
        Example usage:
        
        .. code:: python
        
            import gitsubrepo
        
            remote_repository = "https://github.com/colin-nolan/test-repository.git"
            repository_location = "/tmp/repo"
            subrepo_location = f"{repository_location}/subrepo"
            branch = "develop"
        
            commit_reference = gitsubrepo.clone(remote_repository, subrepo_location, branch=branch)
            updated_commit_reference = gitsubrepo.pull(subrepo_location)
        
            subrepo_remote, subrepo_branch, subrepo_commit = gitsubrepo.status(subrepo_location)
            assert subrepo_remote == remote_repository
            assert subrepo_branch == branch
        
        Development
        -----------
        
        Setup
        ~~~~~
        
        Install both library dependencies and the dependencies needed for
        testing:
        
        .. code:: bash
        
            $ pip install -q -r requirements.txt
            $ pip install -q -r test_requirements.txt
        
        Testing
        ~~~~~~~
        
        To run the tests and generate a coverage report with unittest:
        
        .. code:: bash
        
            $ PYTHONPATH=. coverage run -m unittest discover -v -s gitsubrepo/tests
        
        License
        -------
        
        `MIT license <LICENSE.txt>`__.
        
        Copyright (c) 2017 Genome Research Limited
        
        .. |Build Status| image:: https://travis-ci.org/wtsi-hgi/python-git-subrepo-wrapper.svg?branch=master
           :target: https://travis-ci.org/wtsi-hgi/python-git-subrepo-wrapper
        .. |codecov| image:: https://codecov.io/gh/wtsi-hgi/python-git-subrepo-wrapper/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/wtsi-hgi/python-git-subrepo-wrapper
        .. |PyPI version| image:: https://badge.fury.io/py/gitsubrepo.svg
           :target: https://badge.fury.io/py/gitsubrepo
        
Platform: UNKNOWN
