PyCharm 2023.3 Help

Creating a Flask Project

Flask project in intended for productive development of the Flask applications. PyCharm takes care of creating the specific directory structure, and settings.

Create a Flask project

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

    Create a Flask project

  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:

    • From the Template language list, select the language to be used.

    • In the Templates folder field, specify the directory where the templates will be stored, and where they will be loaded from. You can specify the name of the directory that doesn't yet exist; in this case, the directory will be created.

  5. Click Create.

PyCharm creates an application and produces specific directory structure, which you can explore in the Project tool window. Besides that, PyCharm creates a stub Python script with the name app.py, which provides a simple "Hello, World!" example.

You can run the created application by pressing Shift+F10 Preview the run results.

Run Flask app

Note that the application was run with the following Flask specific variables:

  • FLASK_APP=app.py – Defines an entry point of the Flask application - the target instance of the Flask class. When extending your Flask application and adding more modules and files, you might need to pass some non-default FLASK_APP values. You can pass a module name, a path to the target Python file, or any combination of modules, scripts, and Flask class instances, for example, FLASK_APP=access_management.access:app2, where:

    • access_management – the module name

    • access – the target file in the module

    • app2 – the Flask class instance in access.

    For more information about the FLASK_APP variable, refer to Flask CLI documentation.

  • FLASK_ENV=development – Sets one of possible environments.

  • FLASK_DEBUG=0 – Controls the built-in Flask debug mode. With this mode enabled FLASK_DEBUG=1, the development server will be automatically reloaded on any code change enabling continuous debugging. For more information about Flask debugger, refer to Flask Debug Mode.

You can change Flask specific variables by editing the corresponding parameters of the Flask Server Run/Debug configuration.

When you've enabled Flask support in your project, the Python console starts acting as a Flask console. Use code completion to enter and execute Flask-specific commands.

Flask console
Last modified: 11 February 2024
Flask supportCreating Web Applications with Flask