Search code examples
pythonpython-2.7pipsetuptoolsdistutils

Including .gitignore in setup? - Error: doesn't exist or not a regular file


setup.py

from setuptools import setup, find_packages
from os import path
from functools import partial


if __name__ == '__main__':
    package_name = 'gen'
    templates_join = partial(path.join, path.dirname(__file__), package_name,
                             'templates')
    setup(
        name=package_name,
        test_suite=package_name + '.tests',
        packages=find_packages(),
        package_dir={package_name: package_name},
        package_data={package_name: [templates_join('.gitignore')]}
    )

Tree

.
├── gen
│   ├── __init__.py
│   ├── templates
│   │   ├── __init__.py
│   │   ├── .gitignore
└── setup.py

Error

error: can't copy 'gen/ld/gen/templates/.gitignore': doesn't exist or not a regular file


Solution

  • Confirmed that using data_files works inside/outside a virtualenv on Linux and Windows:

    from setuptools import setup, find_packages
    from os import path
    from functools import partial
    from pip import __file__ as pip_loc
    
    
    if __name__ == '__main__':
        package_name = 'gen'
    
        templates_join = partial(path.join, path.dirname(__file__),
                                 package_name, 'templates')
        install_to = path.join(path.split(path.split(pip_loc)[0])[0],
                               package_name, 'templates')
    
        setup(
            name=package_name,
            version='0.0.1',
            test_suite=package_name + '.tests',
            packages=find_packages(),
            package_dir={package_name: package_name},
            data_files=[(install_to, [templates_join('.gitignore'),
                                      templates_join('logging.conf')])]
        )