Metadata-Version: 1.1
Name: emencia.recipe.patch
Version: 0.1
Summary: recipe for patching eggs
Home-page: http://github.com/emencia/emencia.recipe.patch
Author: J. David Ibanez
Author-email: jdavid@emencia.com
License: GPL
Description: 
        This is a fork of ``collective.recipe.patch``. Main differences are:
        
        - Drop built-in implementation of the patch command. Drop the
          ``patch-binary`` option. Instead calls to the ``patch`` is hard-coded.
        
        - Ignore patches already applied. To do so we pass the ``-N`` parameter
          to the ``patch`` command.
        
        Links:
        
        - https://pypi.python.org/pypi/emencia.recipe.patch - Download
        - https://github.com/emencia/emencia.recipe.patch - Source code
        
        
        Supported options
        =================
        
        The recipe supports the following options:
        
        path
            Define a directory in which the patch should be applied. For
            example::
        
                path = src/some/directory/
        
        egg
            Define which egg should be patched. You can also pin to a specific
            version. For example::
        
                egg = some.egg<=1.1.1
        
        patches
            Paths to patch files. These patches are applied in order. For
            example::
        
                patches = patches/my_very_sprecial.patch
                          patches/another_loverly.patch
        
        Example usage
        =============
        
        Our demo package which we will patch:
        
            >>> mkdir(sample_buildout, 'demo')
            >>> write(sample_buildout, 'demo', 'README.txt', " ")
            >>> write(sample_buildout, 'demo', 'demo.py',
            ... """# demo egg
            ... """)
            >>> write(sample_buildout, 'demo', 'setup.py',
            ... """
            ... from setuptools import setup
            ...
            ... setup(
            ...     name = "demo",
            ...     version='1.0',
            ...     py_modules=['demo']
            ...     )
            ... """)
            >>> print system(buildout+' setup demo bdist_egg'), # doctest: +ELLIPSIS
            Running setup script 'demo/setup.py'.
            ...
        
        Create our patch:
        
            >>> write(sample_buildout, 'demo.patch',
            ... """diff --git demo.py demo.py
            ... --- demo.py
            ... +++ demo.py
            ... @@ -1 +1,2 @@
            ...  # demo egg
            ... +# patching
            ... """)
        
        Let's write out buildout.cfg to patch our demo package:
        
            >>> write(sample_buildout, 'buildout.cfg',
            ... """
            ... [buildout]
            ... parts = demo-patch
            ... index = demo/dist/
            ...
            ... [demo-patch]
            ... recipe = emencia.recipe.patch
            ... egg = demo==1.0
            ... patches = demo.patch
            ... """)
        
        Our final egg name depends on current python version:
        
            >>> import sys
            >>> demoegg = 'demo-1.0-py%d.%d.egg' % sys.version_info[:2]
        
        Running the buildout gives us:
        
            >>> print system(buildout)
            Not found: demo/dist/...
            ...
            Installing demo-patch.
            ...
            Getting distribution for 'demo==1.0'.
            Got demo 1.0.
            patch: reading patch .../demo.patch
            ...
            patch: successfully patched ...develop-eggs/demo-1.0-py...egg/demo.py
        
            >>> ls(sample_buildout, 'develop-eggs', demoegg)
            d  EGG-INFO
            -  demo.py
            -  demo.pyc
            -  demo.pyo
            >>> cat(sample_buildout, 'demo', 'demo.py')
            # demo egg
            >>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py')
            # demo egg
            # patching
        
        Multiple patches
        ----------------
        
        If you have more than one patch to apply:
        
            >>> write(sample_buildout, 'another.patch',
            ... """diff --git demo.py demo.py
            ... --- demo.py
            ... +++ demo.py
            ... @@ -1,2 +1 @@
            ... -# demo egg
            ...  # patching
            ... """)
        
        Update your buildout.cfg to list the new patch. In this case,
        another.patch should be applied after demo.patch:
        
            >>> write(sample_buildout, 'buildout.cfg',
            ... """
            ... [buildout]
            ... parts = demo-patch
            ... index = demo/dist/
            ...
            ... [demo-patch]
            ... recipe = emencia.recipe.patch
            ... egg = demo==1.0
            ... patches =
            ...     demo.patch
            ...     another.patch
            ... """)
        
        Running the buildout gives us:
        
            >>> print system(buildout)
            Not found: demo/dist/...
            ...
            Installing demo-patch.
            ...
            Getting distribution for 'demo==1.0'.
            Got demo 1.0.
            patch: reading patch .../demo.patch
            ...
            patch: successfully patched ...develop-eggs/demo-1.0-py...egg/demo.py
            patch: reading patch .../another.patch
            ...
            patch: successfully patched ...develop-eggs/demo-1.0-py...egg/demo.py
        
            >>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py')
            # patching
        
        Patching an egg installed in another part
        -----------------------------------------
        
        Another possibility is to install an egg with zc.recipe.egg (or
        probably any other recipe) and patch it afterwards.  However, it is
        necessary to install the egg unzipped, and the egg may end up in the
        eggs-folder instead the develop-eggs folder.
        
            >>> write(sample_buildout, 'buildout.cfg',
            ... """
            ... [buildout]
            ... parts = demo-egg demo-patch
            ... index = demo/dist/
            ...
            ... [demo-egg]
            ... recipe = zc.recipe.egg
            ... eggs = demo==1.0
            ... unzip = true
            ...
            ... [demo-patch]
            ... recipe = emencia.recipe.patch
            ... egg = ${demo-egg:eggs}
            ... patches = demo.patch
            ... """)
        
        Running the buildout gives us:
        
            >>> print system(buildout)
            Not found: demo/dist/...
            ...
            Installing demo-egg.
            ...
            Getting distribution for 'demo==1.0'.
            Got demo 1.0.
            Installing demo-patch.
            ...
            patch: successfully patched ...eggs/demo-1.0-py...egg/demo.py
        
            >>> ls(sample_buildout, 'eggs', demoegg)
            d  EGG-INFO
            -  demo.py
            -  demo.pyc
            -  demo.pyo
            >>> cat(sample_buildout, 'demo', 'demo.py')
            # demo egg
            >>> cat(sample_buildout, 'eggs', demoegg, 'demo.py')
            # demo egg
            # patching
        
        Broken patches
        ----------------
        
        If one of the patches is broken:
        
            >>> write(sample_buildout, 'missing-file.patch',
            ... """diff --git missing-file.py missing-file.py
            ... --- missing-file.py
            ... +++ missing-file.py
            ... @@ -1,2 +0 @@
            ... -# BROKEN
            ... -# PATCH
            ... """)
        
        When you try to apply multiple patches, it will fail to apply any
        subsequent patches, letting you fix the problem:
        
            >>> write(sample_buildout, 'buildout.cfg',
            ... """
            ... [buildout]
            ... parts = demo-patch
            ... index = demo/dist/
            ...
            ... [demo-patch]
            ... recipe = emencia.recipe.patch
            ... egg = demo==1.0
            ... patches = missing-file.patch
            ...           demo.patch
            ... """)
        
        Running the buildout gives us:
        
            >>> print system(buildout)
            Not found: demo/dist/...
            ...
            Installing demo-patch.
            patch: reading patch .../missing-file.patch
            ...
            patch: patch: **** malformed patch at line 6:
            While:
              Installing demo-patch.
            Error: could not apply .../missing-file.patch
        
            >>> cat(sample_buildout, 'develop-eggs', demoegg, 'demo.py')
            # demo egg
        
        
        Download
        ********
        
Keywords: buildout recipe patch
Platform: UNKNOWN
Classifier: Framework :: Buildout
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
