Metadata-Version: 1.1
Name: repoman-scm
Version: 0.6.4
Summary: Library and tools to manage pools of code repositories
Home-page: https://github.com/tuenti/python-repoman
Author: Tuenti Technologies S.L.
Author-email: sre@tuenti.com
License: Apache Software License
Download-URL: https://github.com/tuenti/python-repoman/tarball/v0.6.4
Description: Repoman
        =======
        
        Repoman is a python library designed to automate repository operations
        in release processes.
        
        It provides a unified API to work with different SCMs, and the
        mechanisms to quickly have ready and clean working copies. It currently
        supports git and mercurial.
        
        There are some basic concepts that are needed to start working with
        Repoman:
        
        -  A ``Repository`` is an instance with the usual operations of a SCM.
        -  A ``Depot`` contains a repository, and the operations to interact
           with Repoman managers.
        -  A ``DepotManager`` provides ``Depots`` with an specific code, each
           ``DepotManager`` is intended to manage ``Depots`` of the same
           project.
        -  Each ``Depot`` is locked to the task that requests it to the manager
           and belongs to this task till it's freed.
        
        But the best way to see how it works is with an example:
        
        .. code:: python
        
            from repoman import depot_manager
        
            repo_kind = 'git'
            repo_url = 'https://github.com/tuenti/python-repoman.git'
        
            manager = depot_manager.DepotManager(repo_kind=repo_kind)
        
            depot = manager.give_me_depot('task_id', 'Owner task name')
        
            try:
                depot.request_refresh({ repo_url: ['master'] })
        
                # Do work...
                depot.repository.tag('example')
                # ...
        
                # If you were going to continue the task in other process,
                # it needs to receive the path of the depot to request it
                depot = manager.give_me_depot_from_path(depot.path)
                assert 'example' in depot.repository.tags()
        
            finally:
                # And when the repository is not needed anymore, free its depot
                manager.free_depot(depot, 'task_id')
        
        You can know more by looking to the examples in the ``doc/examples``
        directory, and to the full `API reference`_.
        
        Installation
        ------------
        
        Repoman is intended to be used as part of a more complex release
        automation infrastructure, it requires a quite specific set of
        dependencies, see ``Requirements`` section to know more about this.
        
        To install it in your development environment, you can use pip:
        
        ::
        
            pip install -e git+https://github.com/tuenti/python-repoman.git@v0.6#egg=repoman
        
        To install it in your production environment, it's recommended to
        generate your own packages, usual tools can be used for that, e.g:
        
        ::
        
            python setup.py bdist_egg
        
        Requirements
        ------------
        
        Repoman should play well with any Linux distribution with Python > 2.6,
        it's daily used in Debian, and has been also tested in Ubuntu and
        Fedora.
        
        As a general rule, ``pip install -r requirements.txt`` is able to
        install everything, but some things need to be taken into account.
        
        ``pygit2`` needs to be compiled, for that you need a ``gcc`` toolchain
        and the development files of ``libgit2`` (see `pygit2 installation notes`_).
        You have to use the same version of ``pygit2`` and ``libgit2``. Currently
        repoman only works with 0.20 series. It's recommended to prepare your own
        set of pre-built packages for your production enviroment.
        
        ``mercurial`` > 2.1 is also required, as well as ``python-hglib``, the
        version specified in the ``requirements.txt`` file should be fine.
        
        Some Dockerfiles are provided in the ``docker`` directory that can serve
        as examples about how to prepare an environment to work with repoman in
        different distributions.
        
        Credits & Contact
        -----------------
        
        Repoman was created by `Tuenti Technologies S.L.`_. You can follow
        Tuenti engineering team on Twitter `@tuentieng`_.
        
        License
        -------
        
        Repoman is available under the Apache License, Version 2.0. See LICENSE
        file for more info.
        
        .. _`API reference`: http://tuenti.github.io/python-repoman
        .. _`pygit2 installation notes`: http://www.pygit2.org/install.html
        .. _`@tuentieng`: http://twitter.com/tuentieng
        .. _`Tuenti Technologies S.L.`: http://github.com/tuenti
        
Keywords: DVCS git mercurial
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Version Control
