PyCharm Help

Project

On this page:

Basics

Whatever you do in PyCharm, you do that in the context of a project. A project is an organizational unit that represents a complete software solution. It serves as a basis for coding assistance, bulk refactoring, coding style consistency, etc.

Project files

A project in PyCharm is represented in the Directory Based Format. A project directory is marked with python_ProjectIcon.png icon.

Such project directory contains a .idea directory, with the following files:

  • *.iml file that describes the project structure.
  • workspace.xml file that contains your workspace preferences.
  • A number of .xml files. Each .xml file is responsible for its own set of settings, that can be recognized by its name: projectCodeStyle.xml, encodings.xml, vcs.xml etc.

    Thus, for example, adding a new run/debug configuration and changing encoding will affect two different .xml files. This helps avoid merge conflicts when the project settings are stored in a version control system and modified by the different team members.

All the settings files in the .idea directory should be put under version control except the workspace.xml, which stores your local preferences. The workspace.xml file should be marked as ignored by VCS.

.idea directory is not visible in the Project view of the Project tool window.

Project types

The directory structure of each project contains the .idea directory for the PyCharm-specific settings and the project file, and libraries.

PyCharm suggests the following types of projects:

  • Empty project is intended for pure Python programming. The directory structure of such project contains the .idea directory for the PyCharm-specific settings and the project file, and libraries.

    Create a plain Python project as described in the section Creating Empty Project.

  • Django project. This project type provides specific infrastructure of the Django applications, and all the necessary files and settings.

    Create a Django application as described in the section Creating Django Project.

  • Google App Engine project. This project type provides specific infrastructure of the Google App Engine application, and all the necessary files and settings.

    Create project as described in the section Creating Google App Engine Project.

  • Flask project. This project type provides specific infrastructure of a Flask application, and all the necessary files and settings.

    Create project as described in the section Creating Flask Project.

  • Web2Py project. This project type provides specific infrastructure of a Web2Py application, and all the necessary files and settings.

    Create project as described in the section Creating Web2Py Project.

  • Pyramid project. This project type provides specific infrastructure of a Pyramid application, and all the necessary files and settings.

    Create project as described in the section Creating Pyramid Project.

  • Client-side projects HTML5 Boilerplate, Twitter Bootstrap, and Foundation.

    For the client-side applications, PyCharm creates specific infrastructure, with the required files and directories.

    Create project as described in the section Creating Projects from Scratch in PyCharm.

See Also

Last modified: 15 May 2015