How to install dynamic library using setup.py?

Question

I want to distribute a Python package which has a closed source dependency. I am using setup.py and everything works if I also do the compilation with setup.py.

Neither answers to this question nor answers to that question solve my problem.

I have the following file structure:

.
├── closed_source
│   ├── compiled.so
├── python_modules
│   ├── file1.py
│   ├── file2.py
│   ├── ...
│   └── __init__.py
└── setup.py

I also tried to include compiled.so in python_modules. In file1.py I use import compiled which fails.

The following works, but silently fails to include the dynamic library:

setup(
    name='my_package',
    version=0.1,
    packages=['python_modules'],
    package_dir={'python_modules': 'python_modules'},
    package_data={'': ['closed_source/compiled.so']}, # also tried using key compiled
    include_package_data=True,
)

Have you tried putting compiled.so in the python_modules folder? — MattDMo
– MattDMo, Commented Jun 14, 2021 at 0:46
your import is incorrect, it should be from python_modules import compiled if it's included inside the package — anthony sottile
– anthony sottile, Commented Jun 14, 2021 at 0:52
@AnthonySottile Yes, that worked. I used import python_modules.compiled as compiled after putting compiled.so in the python_modules folder. — Niki
– Niki, Commented Jun 14, 2021 at 1:06

Brendan Abel · Accepted Answer · 2021-06-14 01:07:10Z

3

You will have to vendor the dependency. The easiest way to do that is to include the dependency inside your python package, not outside.

setuptools requires you to include a MANIFEST.in file to include non-package, non-python files in your distribution.

See this project for an example of how to do that.

Your project structure should look something like this:

my_package
|-- vendor
    |-- compiled.so
|-- __init__.py
|-- file1.py
|-- file2.py
setup.py

You would also need to import your vendored library using the additional relative prefix

from .vendor import compiled

edited Jun 14, 2021 at 1:07

answered Jun 14, 2021 at 0:51

Brendan Abel

38k16 gold badges101 silver badges126 bronze badges

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

2 Comments

Niki Over a year ago

Perfect, worked. It actually works without a Manifest.in file.

Brendan Abel Over a year ago

@Niki It's possible setuptools recognizes your file extension as a package file. For resource files like txt, jpg, json, etc., it normally won't pick them up by default.

Collectives™ on Stack Overflow

How to install dynamic library using setup.py?

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related