Configure a Poetry environment

Install Poetry

1. Open Terminal (on macOS and Linux) or PowerShell (on Windows) and execute the following command:

   curl -sSL https://install.python-poetry.org | python3 -

   (Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

   curl -sSL https://install.python-poetry.org | python3 -

2. On macOS and Windows, the installation script will suggest adding the folder with the poetry executable to the PATH variable. Do that by running the following command:

   export PATH="/Users/jetbrains/.local/bin:$PATH"

   $Env:Path += ";C:\Users\jetbrains\AppData\Roaming\Python\Scripts"; setx PATH "$Env:Path"

   Don't forget to replace jetbrains with your username!

3. To verify the installation, run the following command:

   poetry --version

   You should see something like Poetry (version 1.2.0).

Refer to the Poetry Installation Instructions for more details.

Create a Poetry environment

1. Do one of the following:

   • Click the Python Interpreter selector and choose Add New Interpreter.

   • Press Control+Alt+S to open Settings and go to Project: <project name> | Python Interpreter. Click the Add Interpreter link next to the list of the available interpreters.

   • Click the Python Interpreter selector and choose Interpreter Settings. Click the Add Interpreter link next to the list of the available interpreters.

2. Select Add Local Interpreter.

3. In the left-hand pane of the Add Python Interpreter dialog, select Poetry Environment.

   

4. The following actions depend on whether you want to create a new Poetry environment or to use an existing one.

   New Poetry environment

   • Select Poetry Environment.

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

   • If PyCharm doesn't detect the poetry executable, specify the following path in the Poetry executable field, 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

   Existing Poetry environment

   • Make sure that the project directory contains a pyproject.toml file.

   • Select Existing environment. Then expand the Interpreter list and choose the desired interpreter.

   • If the desired interpreter is not on the list, click, and then browse for the Python executable within the previously configured Poetry environment.

   The selected Poetry environment will be reused for the current project.

5. Click OK to complete the task.