PyCharm 2017.3 Help

Creating Pyramid Project

This feature is supported in the Professional edition only.

Pyramid project scaffolds are intended for productive development of Pyramid applications. PyCharm takes care of creating the specific directory structure and settings.

To create a Pyramid project, follow these steps

  1. Do one of the following:
    • On the main menu, choose File | New | Project.
    • Click New Project in the Welcome screen.

    Create New Project dialog box opens.

  2. In the Create New Project dialog box, select Pyramid as the project type, and then specify the following:
    • Project location. Note the Pyramid project will be placed within the location and the Project name will inherit the name of the parent directory. Therefore do not use leading underscores for the last segment of the location.
    • Python interpreter to be used for the project.

      If the desired interpreter is not found in the list, click the browse button to review the available interpreters and virtual environments, or configure a new one.

      If Pyramid is missing from the selected interpreter, PyCharm informs you that Pyramid will be installed.

  3. Expand the More Settings section, and do the following:
    • Select the desired scaffold from the drop-down list.
    • Select template language from the drop-down list.
    • Specify template folder.
  4. Click Create.

    If an alert pops up,

    /help/img/idea/2017.3/py_pyramid_popup.png

    click No. We are creating a new project.

    PyCharm creates a project, installs Pyramid and its dependencies, and produces specific directory structure, which you can explore in the Project tool window. Open any file in the project directory. If there are unsatisfied package requirements, PyCharm suggests to resolve or ignore them:

    /help/img/idea/2017.3/py_install_requirements.png

    You should install the dependencies to be able to run the development server.

    When you create a Pyramid project, you must run setup.py develop to install the project for development. PyCharm might inform you to do so as shown in the screenshot below:

    /help/img/idea/2017.3/py_setup_develop.png

    Alternatively, you can select Tools | Run setup.py Task... and enter develop. Another pop-up dialog appears Run Setup Task develop. Click OK.

    If you created an alchemy-based project, you need to initialise the database, open the terminal (make sure virtual environment is active) and run the command:

    initialize_PROJECTNAME_db development.ini

    (Replace PROJECTNAME with your exact project name.)

See Also

Last modified: 15 September 2017