Metadata-Version: 1.0
Name: gitegginfo
Version: 0.3
Summary: Setuptools extension to use Git version information
Home-page: http://github.com/trammell/gitegginfo
Author: John Trammell
Author-email: johntrammell@gmail.com
License: GPL
Description: ==========
        gitegginfo
        ==========
        
        Introduction
        ============
        
        Package ``gitegginfo`` adds two setuptools_ commands to make it possible to
        use setuptools with git repositories when building development eggs.  Problems
        occur in that setuptools specifically looks for subversion_ revision numbers,
        even when subversion is not the underlying SCM.
        
        This package is intended for use with git-svn_, which I use as an interface
        between git and subversion.
        
        gitegginfo
        ----------
        
        The ``gitegginfo`` command is an extension of setuptools' egg_info command.
        Where the egg_info command is unwisely specific to the subversion_ version
        control system, the gitegginfo command is unwisely and explicitly tied to the
        Git DVCS (distributed version control system).
        
        gitsdist
        --------
        
        The ``sdist`` command that comes with setuptools is used to generate source
        distributions, i.e. tarballs. When building a development ("dev") egg,
        setuptools attempts to query the current revision number via the ``egginfo``
        command, which fails for reasons described above.  The ``gitsdist`` command
        instead uses the ``gitegginfo`` command to get the revision information.
        
        
        Sample Commands
        ===============
        
        To build an ``.egg-info`` folder with ``git-svn`` revision data::
        
           python setup.py gitegginfo -r
        
        To build a development source distribution::
        
           python setup.py gitegginfo -rDb dev gitsdist
        
        
        Troubleshooting
        ===============
        
        If you run into the problem where setuptools isn't including all your code in
        the created egg, you may need to install package setuptools-git_.
        
        
        Editorial
        =========
        As I write this, the Python packaging infrastructure is in a dismal state.
        
        
        See Also
        ========
        
        distutils_, git_, git-svn_, sdist_, setuptools_, setuptools-git_, subversion_
        
        .. _distutils:      http://docs.python.org/distutils/index.html
        .. _git:            http://git-scm.com/
        .. _git-svn:        http://www.kernel.org/pub/software/scm/git/docs/git-svn.html
        .. _sdist:          http://docs.python.org/distutils/sourcedist.html
        .. _setuptools:     http://pypi.python.org/pypi/setuptools
        .. _setuptools-git: http://pypi.python.org/pypi/setuptools-git/0.3.3
        .. _subversion:     http://en.wikipedia.org/wiki/Apache_Subversion
        
        
        Changes
        =======
        
        0.2 - 2010-06-22
        ----------------
        * bug fix / 'git-svn' invocation
        
        0.1 - 2010-04-08
        ----------------
        * pulls git-svn revision [jt]
        
        
        
Keywords: setuptools egg_info git
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
