Python setup.py include .json files in the egg

Question

I want to package .json files as well in the python egg file.

For example: boto package has endpoints.json file. But when I run python setup.py bdist_egg it does not include the json file in the egg. How do I include the Json file in the egg?

How do I include *.json file in the egg?

Below is the setup.py code

from setuptools import setup, find_packages, Extension

setup(
  name='X-py-backend',
  version='tip',
  description='X Python backend tools',
  author='meme',
  packages=find_packages('python'),
  package_dir={'': 'python'},
  data_files=[('boto', ['python/boto/endpoints.json'])],
  namespace_packages = ['br'],
  zip_safe=True,
)

setup(
  name='X-py-backend',
  version='tip',
  packages=find_packages('protobuf/target/python'),
  package_dir={'': 'protobuf/target/python'},
  namespace_packages = ['br'],
  zip_safe=True,
)

Edwin Lunando · Accepted Answer · 2015-05-12 05:13:31Z

20

You only need to list the file on data_files parameter. Here is the example.

setup(
  name='X-py-backend',
  version='tip',
  description='XXX Python backend tools',
  author='meme',
  packages=find_packages('python'),
  package_dir={'': 'python'},
  data_files=[('boto', ['boto/*.json'])]
  namespace_packages = ['br'],
  zip_safe=True
)

You can see the details here. https://docs.python.org/2/distutils/setupscript.html#installing-additional-files

Another way to do this is to use MANIFEST.in files. you need to create a MANIFEST.in file in your project root. Here is the example.

include python/boto/endpoints.json

Please visit here for more information.https://docs.python.org/2/distutils/sourcedist.html#manifest-template

edited May 12, 2015 at 5:13

answered May 11, 2015 at 10:59

Edwin Lunando

2,8163 gold badges27 silver badges35 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Bourne Over a year ago

This does not work. I ran "python setup.py bdist_egg" after making this change. When I unzip the .egg file I don't find "endpoints.json" file inside boto package. Am I missing something here?

Edwin Lunando Over a year ago

Please share your edited setup.py. I will look into it.

Mrinal · Accepted Answer · 2019-03-01 17:53:05Z

13

Well this works for me.

setup.py:

from setuptools import setup, find_packages

setup(
    name="clean",
    version="0.1",
    description="Clean package",
    packages=find_packages() + ['config'],
    include_package_data=True
)

MANIFEST.in:

recursive-include config *

where there is a config file under the project root directory which contains a whole bunch of json files.

Hope this helps.

answered Mar 1, 2019 at 17:53

Mrinal

1,9043 gold badges22 silver badges32 bronze badges

2 Comments

Peter Badida Over a year ago

I had data_files and everything properly included with glob etc, but *.json files were not. After I saw your post with include_package_data kwarg I used it (though I thought it'd work only for package_data) and tada, everything packaged correctly without MANIFEST.in! Thanks!

Gabe Morris Over a year ago

I did this, but I had to include the MANIFEST.in file unlike @PeterBadida.

Rajeshwar Sharma · Accepted Answer · 2025-05-14 08:32:04Z

0

I was having *json data in resources folder as resources/params.json inside package src and the setup.py configuration that works in my case is as below

from setuptools import setup, find_packages


setup(
    name='project_dummy',
    version='0.1.0',
    packages=find_packages(include=['src', 'src.*']),
    package_data={'src': ['resources/*.json']},
    install_requires=[
        'numpy==1.24',
    ...

Below is the code structure I have

├── setup.py
├── src
│   ├── __init__.py
│   ├── __pycache__
│   ├── config
│   ├── crg
│   ├── resources
│   └── utilities

answered May 14 at 8:32

Rajeshwar Sharma

314 bronze badges

Collectives™ on Stack Overflow

Python setup.py include .json files in the egg

3 Answers 3

2 Comments

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related