How to install python cli scripts with setuptools without duplicates?

Question

I have 2 Python scripts that can be used from the shell as they are thanks to argparse.

The relevant part of setup.py:

setup(
    # (...)
    zip_safe=True,
    scripts=['bin/bgce.py', 'bin/sizes.py'],
    packages=find_packages(),
    data_files=data_files,
    entry_points = {
        'console_scripts': [
            'bgce = bgce:main',
            'sizes = sizes:main',]
    }
)

I end up with bgce, bgce.py, sizes, sizes.py in /usr/local/bin. All 4 work.

If I leave out either the packages or the scripts line, there are no duplicates, but the files fail like this:

Traceback (most recent call last):
File "/usr/local/bin/bgce", line 9, in <module>
    load_entry_point('Backtestground==1.0', 'console_scripts', 'bgce')()
File "/usr/lib/python2.6/dist-packages/pkg_resources.py", line 305, in load_entry_point return get_distribution(dist).load_entry_point(group, name)
File "/usr/lib/python2.6/dist-packages/pkg_resources.py", line 2244, in load_entry_point return ep.load()
File "/usr/lib/python2.6/dist-packages/pkg_resources.py", line 1954, in load
    entry = __import__(self.module_name, globals(),globals(), ['__name__'])
ImportError: No module named bgce

What can I do to only have bgce and sizes installed, no duplicates with annoying (for tab-completion) .py attached?

l0r3zz · Accepted Answer · 2011-07-17 17:08:30Z

4

Make sure that the actual modules have a main function like this:

def main():
    try:
        some_stuff()
    except KeyboardInterrupt :
        print ""
        sys.exit()

if __name__ == "__main__" :
    main()

We often do the pattern of writing out main code below the if __name__ == "__main__" : and if there isn't an actual main(), distutils can't get a load point. (Catching ^C is optional :) I had this problem too until I accidentally discovered that one of my modules actually worked while the others didn't. This was the difference, once corrected, it's all good!

edited Jul 17, 2011 at 17:08

answered Jul 17, 2011 at 17:02

l0r3zz

413 bronze badges

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

Comments

Tobu · Accepted Answer · 2010-12-05 16:44:15Z

0

IIRC: Have bgce.py and sizes.py part of your packages, remove the scripts argument, keep the entry points.

answered Dec 5, 2010 at 16:44

Tobu

25.6k4 gold badges95 silver badges100 bronze badges

3 Comments

thorwil Over a year ago

find_packages() returns 'bin', the dir where both scripts are. Removing the scripts arguments results in only 2 files, but both fail with the ImportError.

Tobu Over a year ago

bcge = bin.bcge:main would work, with the files installed in /usr/local/share/python$VER/site-packages/bin/bcge.py. Once this works you can rename bin into something that makes sense for a package.

thorwil Over a year ago

That doesn't work, either. The scripts end up in /usr/local/bin, but look for modules below /usr/lib/, when those are below /usr/local/lib/

Collectives™ on Stack Overflow

How to install python cli scripts with setuptools without duplicates?

2 Answers 2

Comments

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related