Can't import module from bin directory of the same project

Question

I'm building a library that will be included by other projects via pip.

I have the following directories ('venv' is a virtualenv):

project
  \- bin
     \- run.py
  \- myproj
     \- __init__.py
     \- logger.py
  \- venv

I activate the virtualenv.

In bin/run.py I have:

from myproj.logger import LOG

but I always get

ImportError: No module named myproj.logger

The following works from the 'project' dir:

python -c "from myproj.logger import LOG"

It's not correctly adding the 'project' directory to the pythonpath when called from the 'bin' directory. How can I import modules from 'myproj' from scripts in my bin directory?

jfs · Answer 1 · 2017-09-23T18:46:48.607

9

Install myproject into venv virtualenv; then you'll be able to import myproject from any script (including bin/run.py) while the environment is activated without sys.path hacks.

To install, create project/setup.py for the myproject package and run from the project directory while the virtualenv is active:

$ pip install -e .

It will install myproject inplace (the changes in myproject modules are visible immediately without reinstalling myproject).

edited Sep 23 '17 at 18:46

answered May 29 '13 at 14:30

jfs

399,953
195
994
1,670

1

Given the OP is using a virtualenv this should be the accepted answer. – kkurian Sep 23 '17 at 18:23

score 5 · Accepted Answer · edited Jun 20 '20 at 09:12

5

The solution here is to source the virtualenv you have and then install the package in developer mode.

source venv/bin/activate

pip install -e .

You can then import myproject.logger from run.py.

You'll need to create a setup.py file as well to be able to install the package into your environment. If you don't already have one you can read the official documentation here.

edited Jun 20 '20 at 09:12

Community

1
1

answered May 29 '13 at 14:14

eandersson

25,781
8
89
110

2

Given that OP uses virtualenv; `sys.path` manipulations are [unnecessary](http://stackoverflow.com/a/16816683/4279) or even [harmful](http://stackoverflow.com/a/14186074/4279). – jfs May 29 '13 at 14:41
2

I prefer to use an absolute path from the script so the script can be run from anywhere. `sys.path.append(os.path.join(os.path.dirname(sys.argv[0]), '..'))` – Maxime Oct 27 '15 at 22:22

score 1 · Answer 3 · answered May 29 '13 at 14:16

Only the current working directory is inside the PYTHONPATH, which is used to resolved dependencies. So, if you are inside bin and execute your script, project is not in the path anymore. You have to use one of the common methods to add project to the PYTHONPATH, either by appending to the environment variable or through editing the sys.path list programmatically, as indicated in the other answer.

score 0 · Answer 4 · answered May 29 '13 at 14:32

0

add the path of project in the PYTHONPATH

answered May 29 '13 at 14:32

Ying.Zhao

154
3
13

Can't import module from bin directory of the same project

4 Answers4

Linked