Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

python installing package with submodules

I have a custom project package with structure like:

 package-dir/
     mypackage/
         __init__.py
         submodule1/
              __init__.py
              testmodule.py
         main.py
     requirements.txt
     setup.py

using cd package-dir followed by $pip install -e . or pip install . as suggested by python-packaging as long as I access the package from package-dir

For example :

 $cd project-dir
 $pip install .

at this point this works:

 $python -c 'import mypackage; import submodule1'

but This does not work

 $ cd some-other-dir
 $ python -c 'import mypackage; import submodule1'
 Traceback (most recent call last):
 File "<stdin>", line 1, in <module>
 ImportError: No module named submodule1

How to install all the submodules?

also, if i check the package-dir/build/lib.linux-x86_64-2.7/mypackage dir, I only see the immediate files in mypackage/*.py and NO mypackage/submodule1

setup.py looks like:

from setuptools import setup
from pip.req import parse_requirements

reqs = parse_requirements('./requirements.txt', session=False)
install_requires = [str(ir.req) for ir in reqs]


def readme():
    with open('README.rst') as f:
        return f.read()

setup(name='mypackage',
      version='1.6.1',
      description='mypackage',
      long_description=readme(),
      classifiers=[

      ],
      keywords='',
      url='',
      author='',
      author_email='',
      license='Proprietary',
      packages=['mypackage'],
      package_dir={'mypackage': 'mypackage'},
      install_requires=install_requires,
      include_package_data=True,
      zip_safe=False,
      test_suite='nose.collector',
      tests_require=['nose'],
      entry_points={
          'console_scripts': ['mypackage=mypackage.run:run'],
      }
      )
like image 214
muon Avatar asked Jul 13 '17 17:07

muon


People also ask

How do you add a package to Python?

Installing Python Packages with Setup.py To install a package that includes a setup.py file, open a command or terminal window and: cd into the root directory where setup.py is located. Enter: python setup.py install.

How do I get-PIP in Python?

Step 1: Download the get-pip.py (https://bootstrap.pypa.io/get-pip.py) file and store it in the same directory as python is installed. Step 2: Change the current path of the directory in the command line to the path of the directory where the above file exists. Step 4: Now wait through the installation process. Voila!


1 Answers

setup.py is missing information about your package structure. You can enable auto-discovery by adding a line

setup(
    # ...
    packages=setuptools.find_packages(),
)

to it.

like image 70
Nils Werner Avatar answered Oct 17 '22 01:10

Nils Werner