What's the best way to distribute python command-line tools?

Question

My current setup.py script works okay, but it installs tvnamer.py (the tool) as tvnamer.py into site-packages or somewhere similar..

Can I make setup.py install tvnamer.py as tvnamer, and/or is there a better way of installing command-line applications?

Does this answer your question? setup.py and adding file to /bin/ — user202729
– user202729, Commented Dec 6, 2021 at 6:31

dbr · Accepted Answer · 2012-06-28 20:48:32Z

38

Try the entry_points.console_scripts parameter in the setup() call. As described in the setuptools docs, this should do what I think you want.

To reproduce here:

from setuptools import setup

setup(
    # other arguments here...
    entry_points = {
        'console_scripts': [
            'foo = package.module:func',
            'bar = othermodule:somefunc',
        ],
    }
)

edited Jun 28, 2012 at 20:48

dbr

171k69 gold badges284 silver badges348 bronze badges

answered Aug 20, 2008 at 13:25

Blair Conrad

244k25 gold badges137 silver badges114 bronze badges

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

2 Comments

Craig McQueen Over a year ago

When I try this with Python 2.6 and 3.1, I get a message UserWarning: Unknown distribution option: 'entry_points'. So I guess it's not supported in the distutils that comes with Python (2.6 and 3.1). So, is it okay to use this option if we want to distribute on PyPI?

cmcginty Over a year ago

on Ubuntu 11.04, install python-setuptools. Make sure you setup.py is importing: 'from setuptools import setup'

Collectives™ on Stack Overflow

What's the best way to distribute python command-line tools?

1 Answer 1

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related