PyCharm 2017.2 Help

Creating and Running setup.py

Introduction

PyCharm provides an action that helps create setup.py script, intended for building, distributing, and installing modules.

Once setup.py is created, the corresponding action becomes disabled, but instead appears the action that allows running tasks of this utility.

Creating setup.py

To create setup.py for a project

  1. In the Project tool window, choose the project you want to package.
  2. On the main menu, choose Tools | Create setup.py.
  3. In the New Setup Script dialog box, specify package name, version and the other required information:
    /help/img/idea/2017.2/create-setup-py.png
  4. Click OK when ready. PyCharm creates setup.py and opens it in the editor.

Running setup.py

To run a task of the setup.py utility

  1. On the main menu, choose Tools | Run setup.py.
  2. In the Enter setup.py task name dialog box, type the letters of the task names. Note that asterisk wildcard and initial letters of the snake_case names are honored.

    As you type, the suggestion list shrinks to show the matching names only. Choose the desired task, and press Enter.

    /help/img/idea/2017.2/py_run_setup_script.png

See Also

Last modified: 9 August 2017