Python: include library folder when running from command line

Question

I have a directory structure:

root_dir
 ├── src
 │   └── p1.py
 └── lib
     ├── __init__.py
     ├── util1.py
     └── util2.py

I want to run src/p1.py which uses lib/util1.py using an import statement import lib.util1 as u1.

It runs fine when I use PyCharm, but I want to also run it from command line. How can I run the program from command line?

I have tried cd root_dir then python src/p1.py.

But it produces the following error:

Traceback (most recent call last):
  File "./src/p1.py", line 1, in <module>
    import lib.util1 as u1
ImportError: No module named lib.util1

How can I run the python program src/p1.py from the command line?

Edit: Based on the suggestion from @Sumedh Junghare, in comments, I have added __init__.py in lib folder. But still it produces the same error!

you can make lib a python package by adding __init__.py in this directory. Then you can use import statement as usual. — Sumedh Junghare
– Sumedh Junghare, Commented Dec 13, 2018 at 10:52

Saiful Azad · Accepted Answer · 2018-12-13 11:19:33Z

2

You need the following steps

Add __init__.py at lib folder.

Add this line at p1.py file on top

import sys
sys.path.append('../') 
import lib.util1 as u1

Run the p1.py file from src dir. Hope it will work.

Edit:

If you do not want to add sys.path.append('../'), set PYTHONPATH in env-var from this resource. How to add to the pythonpath in Windows?

edited Dec 13, 2018 at 11:19

answered Dec 13, 2018 at 10:59

Saiful Azad

1,9593 gold badges17 silver badges29 bronze badges

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

2 Comments

Sourabh Bhat Over a year ago

I have seen similar solutions on Stackoverflow. But I don't want to change the source files as it is running fine in PyCharm. Is it possible to tell python to include lib folder? I think since PyCharm is able to do it, it must be possible without changing the source.

arudzinska Over a year ago

This is because if you run python in the PyCharm's terminal it has different sys.path. Try running interactive python both in the PyCharm's terminal and in your normal terminal and then: import sys and print(sys.path)and compare the output.

yossiz74 · Accepted Answer · 2021-08-03 05:04:21Z

0

Improving on Saiful's answer, You can do the following which will allow you to run the your program from any working directory

import sys
import os
sys.path.append(os.path.join(os.path.realpath(os.path.dirname(__file__)), "../"))
import lib.util1 as u1

answered Aug 3, 2021 at 5:04

yossiz74

9291 gold badge9 silver badges16 bronze badges

Collectives™ on Stack Overflow

Python: include library folder when running from command line

2 Answers 2

2 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related