我应该如何为此设置 python 包

Question

I am creating a tool I plan to put on Github. It is very general however I want to also include some examples of its usage. As such I have set up the following folder structure.

This tool is for python 3.

repository/
   commonTool.py
   commonTool2.py
   specificUsage/
     runTheSpecificUsage.py
     helpRunTheSpecificUsage.py

Now both of the scripts in the specificUsage/ folder will import the methods in commonTool.py and commonTool2.py.

My issue is ideally the user would be able to go

python repository/specificUsage/runTheSpecificUsage.py

However I cant get this to work. It never is able to import the functions that are in the folder above it. I have tried a variety of various posts on how to import a file from a super folder with no luck.

How should I be setting up these folders? Should I have one init .py or two? Where?

Answer 1

You can create a setup.py at the top level along with commonTool.py and commonTool2.py . Inside your setup.py, put the following line:

import setuptools
setuptools.setup(packages=setuptools.find_packages())

Then put an __init__.py in the same level, as well as in specificUsage/ . You should be able to import from specificUsage like this:

import commonTool

After setting up your files, from the top level run:

pip install -e .

You may also want to consider that Python has strong naming conventions for modules and packages and frowns upon camelcase in general. You can read more here if you like.