Creating a Python Package That Adds Script to Path

Question

I'm working on a Python package, and I'd like to add a script to the users PATH once they install it. I'm not sure if this is the correct terminology, so here's an example of what I'd like to accomplish:

user installs package via pip

pip install my-pkg

once installed the user can enter the following in their termial

my-pkg start

this then creates a settings.py/index.html files in the current dir

This is similar to running django-admin startproject. Thanks for any help.

Ray Johns · Accepted Answer · 2021-02-17 20:49:21Z

3

You can do this by specifying that script in your setup.py as an entrypoint.

If using a pyproject.toml, the equivalent is a plugin.

edited Feb 17, 2021 at 20:49

answered Feb 17, 2021 at 20:47

Ray Johns

8087 silver badges14 bronze badges

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

1 Comment

DeepSpace Over a year ago

... if OP is using setup.py... This is done in other ways in other tools (for example poetry's pyproject.toml)

sarartur · Accepted Answer · 2021-02-17 20:53:42Z

0

Just to expand on @Ray Johns answer, this is what it would look like inside your setuptools.setup function.

entry_points = {
        'console_scripts': [
            'command = my-pkg.module:func',                  
        ], 
}

answered Feb 17, 2021 at 20:53

sarartur

1,2281 gold badge7 silver badges13 bronze badges

Collectives™ on Stack Overflow

Creating a Python Package That Adds Script to Path

2 Answers 2

1 Comment

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Related