Source: Kl Insight Blog

Kl Insight Blog Setuptools' include_package_data does not work

MANIFEST.in not honoured during install phaseThe python package setup procedure appears to be a mess, you have setuptools, distutils, distutils2 on the way and something new in Python3. All I set out to do was to fix the installation setup.py in django-simplemenu package which was omitting the not python plain locale directory but instead got myself involved a 3 hour roller coaster.Including sub directories and non python files as part of packageThere are two ways: MANIFEST.in file and package_data setup.py option. The latter is Pythonic but doesn't do recursive includes - so you would have to list every sub directory - and can not include files in the root top most folder; sure once could write a python function to do this but why the complexity? MANIFEST.in with its file/directory pattern matching and with the setup.py's ``include_package_data`` option fits the bill:``include_package_data`` If set to ``True``, this tells ``setuptools`` to automatically include any data files it finds inside your package directories, that are either under CVS or Subversion control, or which are specified by your ``MANIFEST.in`` file. For more information, see the section below on `Including Data Files`_.The problem is that does not work, files specified in MAIFEST.in weren't being copied during install. After searching and trial an error the solution was to use distutils instead of the setuptools package. So if you are having issues import distuitls rather then setuptools.My django-simplemenu setup.pyfrom distutils.core import setupfrom setuptools import find_packagespackage = __import__('simplemenu')setup(name='django-simplemenu', version=package.get_version(), url='http://github.com/danielsokolowski/django-simplemenu', license='BSD', description=package.__doc__.strip(), author='Alex Vasi , Justin Steward , Daniel Sokolowski ', author_email='unemelpmis-ognajd@danols.com', include_package_data=True, # this will use MANIFEST.in during install where we specify all of our additional files packages=find_packages(), # Below is not needed as we are utilizing MANIFEST.in #package_data={'simplemenu': ['locale/en/LC_MESSAGES/*', # 'locale/ru/LC_MESSAGES/*'] # }, scripts=[], requires=[], )My django-simplemenu MANIFEST.ininclude LICENSEinclude README.rstrecursive-include simplemenu *.pyrecursive-include simplemenu/locale *prune simplemenu/migrations

Read full article »
Est. Annual Revenue
$100K-5.0M
Est. Employees
25-100
CEO Avatar

CEO

Update CEO

CEO Approval Rating

- -/100



Kl Insight is a Private company. Kl Insight generates $113.1K in revenue per employee Kl Insight has 1 followers on Owler.