Ran4/python_modules_reference

Example python module-in-package setup

Showcases how to setup a python project as a project with mutliple modules.

Directory setup:

    setup.py
    programname/
        __init__.py
        __main__.py
        sub/
            __init__.py
            subfile.py

Run the main program with python -m programname.

# setup.py
from distutils.core import setup

setup(
    name="Program example",
    license='LICENSE.txt',
    version='0.1.0',
    author='Nah Nah',
    author_email='nah@nah.com',
    description='CLI for Layke',
    #~ requires=[],
    packages=[
        "programname",
        "programname/sub",
    ],
    package_dir={
        "programname": "programname",
        "programname/sub": "programname/sub",
    },
)

# __main__.py
from programname.main_helper import red
from programname.sub.subfile import subfunc
if __name__ == "__main__":
    red("from main")

# main_helper.py
print("main_helper")

def red(x):
    print("from red:", x)

# sub/subfile.py
from programname.main_helper import red

def subfunc():
    red("from subfunc")