Python packaging: subdirectories not installed

Question

I have a Python project with the layout

setup.py
foobar/
    __init__.py
    foo.py
    bar/
        __init__.py

Where the foobar/__init__.py reads

from . import foo
from . import bar

and setup.py

from setuptools import setup

setup(
    name='foobar',
    version='0.0.1',
    packages=['foobar'],
    )

When doing import foobar from the source directory, it all works as expected. However, when installing the package via pip install ., the subfolder bar/ is not installed, leading to the import error

ImportError: cannot import name bar

Any hints?

try this link for __init__.py http://stackoverflow.com/questions/1944569/how-do-i-write-good-correct-package-init-py-files — shiva, Apr 06 '17 at 11:37

Nico Schlömer · Accepted Answer · 2018-01-20T18:40:14.943

27

Apparently to include subpackages, you need find_packages():

from setuptools import setup, find_packages

setup(
    name='foobar',
    version='0.0.1',
    packages=find_packages()
    )

This is recommended in the setuptools docs as well.

edited Jan 20 '18 at 18:40

answered Apr 06 '17 at 11:36

Nico Schlömer

53,797
27
201
249

Exact Link: https://setuptools.readthedocs.io/en/latest/setuptools.html#using-find-packages – deepelement Aug 14 '17 at 14:33
6

find_packages() installs the subdirectory, but the import still fails. – Derek Aug 14 '19 at 08:03
Same here, the subdirectories are installed, but cannot import. Found an answer to this at some point? – Niels Uitterdijk May 26 '21 at 08:15

Python packaging: subdirectories not installed

1 Answers1