PyCharm 2023.3 Help

Creating Google App Engine Project

A Google App Engine project is intended for productive development of web applications in the Google infrastructure. PyCharm takes care of creating the specific directory structure and settings.

To create a Google App Engine project, follow these steps

Note that PyCharm always uses the Python 2.7 runtime when creating a new project.

  1. In the main menu, go to File | New Project, or click the New Project button in the Welcome screen.

  2. In the New Project dialog, do the following:

  3. If you want to proceed with the Project venv or Base conda interpreter, select the corresponding option and click Create.

    Project venv

    PyCharm creates a virtualenv environment based on the system Python in the project folder.

    Base conda

    PyCharm configures conda base environment as the project interpreter.

    To configure an interpreter of other type or to use an existing environment, select Custom environment.

    The following steps depend on your choice:

    Create a project with a conda environment
    • Select the Python version from the list.

    • Normally, PyCharm will detect conda installation.

      Otherwise, specify the location of the conda executable, or click Conda executable location to browse for it.

    • Specify the environment name.

    Create a project with virtualenv
    • Specify the location of the new virtual environment in the Location field, or click Virtual environment location and browse for the desired location in your file system. The directory for the new virtual environment should be empty.

    • Choose the base interpreter from the list, or click Choose the base interpreter and find the desired Python executable in your file system.

    • Select the Inherit global site-packages checkbox if you want all packages installed in the global Python on your machine to be added to the virtual environment you're going to create. This checkbox corresponds to the --system-site-packages option of the virtualenv tool.

    • Select the Make available to all projects checkbox if you want to reuse this environment when creating Python interpreters in PyCharm.

    Create a project with Pipenv

    Choose the base interpreter from the list, or click Choose the base interpreter and find the desired Python executable in your file system.

    If you have added the base binary directory to your PATH environmental variable, you don't need to set any additional options: the path to the pipenv executable will be autodetected.

    If the pipenv executable is not found, follow the pipenv installation procedure to discover the executable path, and then specify it in the dialog.

    Create a project with Poetry

    Choose the base interpreter from the list, or click Choose the base interpreter and find the desired Python executable in your file system.

    If PyCharm doesn't detect the poetry executable, specify the following path in the dialog, replacing jetbrains with your username:

    /Users/jetbrains/Library/Application Support/pypoetry/venv/bin/poetry
    C:\Users\jetbrains\AppData\Roaming\pypoetry\venv\Scripts\poetry.exe
    /home/jetbrains/.local/bin/poetry
    Selecting existing conda interpreter for a new project

    To reuse an existing conda environment:

    • Switch Type to Conda.

    • Normally, PyCharm will detect conda installation.

      Otherwise, specify the location of the conda executable, or click Conda executable location to browse for it.

    • Select the environment from the list. If you specified the path to conda manually, you may need to reload environments.

    Selecting existing interpreter for a new project

    To reuse a Virtualenv, Pipenv, or Poetry environment:

    • Switch Type to Python.

    • Select the Python executable from the list or click to browse for it.

  4. Click More settings More Settings, and specify the following:

    • In the Application ID field, enter the identifier that you have already defined on the Create application page of the Google App Engine. The project identifier should meet certain requirements: only lower-case letters, digits, and "-" characters are allowed; the application id should not begin with "-".

    • App Engine SDK directory - the location of the App Engine SDK on your machine. If this SDK is missing from the path variable, type it manually or click the Browse button and locate the required directory from the file system. If the SDK directory is added to the path variable during installation, it is detected automatically.

  5. Click Create.

Once the project is created, you should see the following files in the Project tool window:

  • app.yml: a file to configure your App Engine app's settings. See more details and examples in the app.yaml reference.

  • main.py: an application boilerplate. If you enable using third-party libraries when creating the project, the corresponding code templates, for example, Django or Flask, will be added.

Use code intentions and quick fixes to install the missing packages

quick fixes for the missing packages
Last modified: 11 February 2024