How to include library dependencies with a python project?

Question

I'm working on a program which a few other people are going to be using, made in Python. They all have python installed, however, there are several libraries that this program imports from.

I would ideally like to be able to simply send them the Python files and them be able to just run it, instead of having to tell them each of the libraries they have to install and as them to get each one manually using pip.

Is there any way I can include all the libraries that my project uses with my Python files (or perhaps set up an installer that installs it for them)? Or do I just have to give them a full list of python libraries they must install and get them to do each one manually?

ivan_pozdeev · Accepted Answer · 2017-07-12 10:09:21Z

7

That's the topic of Python packaging tutorial.

In brief, you pass them as install_requires parameter to setuptools.setup().

You can then generate a package in many formats including wheel, egg, and even a Windows installer package.

Using the standard packaging infrastructure will also give you the benefit of easy version management.

answered Jul 12, 2017 at 10:09

ivan_pozdeev

36.6k19 gold badges115 silver badges165 bronze badges

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

Comments

Benjamin Loison · Accepted Answer · 2023-11-21 21:39:15Z

2

You can build a package and specify dependencies in your setup.py. This is the right way

https://python-packaging.readthedocs.io/en/latest/dependencies.html

from setuptools import setup

setup(name='funniest',
  version='0.1',
  description='The funniest joke in the world',
  url='http://github.com/storborg/funniest',
  author='Flying Circus',
  author_email='[email protected]',
  license='MIT',
  packages=['funniest'],
  install_requires=[
      'markdown',
  ],
  zip_safe=False)

The need it now hack option is some lib that lets your script interact with shell. pexpect is my favorite for automating shell interactions.

https://pexpect.readthedocs.io/en/stable/

edited Nov 21, 2023 at 21:39

Benjamin Loison

5,7504 gold badges20 silver badges37 bronze badges

answered Jul 12, 2017 at 10:14

Xingzhou Liu

1,5799 silver badges13 bronze badges

1 Comment

Vishrant Over a year ago

This does not include the dependencies in the package, but they will be installed when you will install this module.

pythad · Accepted Answer · 2017-07-12 10:19:58Z

1

You should use virtualenv to manage packages of your project. If you do, you can then pip freeze > requirements.txt to save all dependencies of a project. After this requirements.txt will contain all necessary requirements to run your app. Add this file to your repository. All packages from requirements.txt can be install with

pip install -r requirements.txt

The other option will be to create a PyPI package. You can find a tutorial on this topic here

edited Jul 12, 2017 at 10:19

answered Jul 12, 2017 at 10:07

pythad

4,2972 gold badges23 silver badges41 bronze badges

2 Comments

ivan_pozdeev Over a year ago

This requires the package to be available at PyPI, too.

wim Over a year ago

requirements.txt is used for pinning versions. It's not for specifying dependencies, that's the job of setup.py.

Collectives™ on Stack Overflow

How to include library dependencies with a python project?

3 Answers 3

Comments

1 Comment

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

Comments

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related