Configure a Pipenv environment

Install Pipenv

1. Run the following command to ensure you have pip installed in your system:

   $ pip --version

   You should expect to receive a system response indicating the pip version. If no pip is discovered, install it as described in the Installation Instructions. Alternatively, you can download and install Python from http://python.org.

2. Install pipenv by running the following command:

   $ pip install --user pipenv

   When installation completes, you will see the following message:

   

3. For your convenience, you might add the user base’s binary directory to your PATH environmental variable. If you skip this procedure, PyCharm will prompt you to specify the path to the pipenv executable when adding a pipenv environment.

   1. Run the following command:

      $ py -m site --user-site

      A sample output can be:

      C:\Users\jetbrains\AppData\Roaming\Python\Python37\site-packages

   2. Replace site-packages with Scripts in this path to receive a string for adding to the PATH variable, for example:

      $ setx PATH "%PATH%;C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts"

   1. Run the following command to find the user base's binary directory:

      $ python -m site --user-base

      An example of output can be

      /Users/jetbrains/.local (macOS) or /home/jetbrains/.local (Linux)

   2. Add bin to this path to receive a string for adding to the ~/.bashrc file, for example:

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

   3. Run the following command to make the changes effective:

      $ source ~/.bashrc

   4. Ensure you have enabled bashrc in your bash_profile.

At any time you can alter the specified path to the pipenv executable in the project settings. In the Settings dialog (Ctrl+Alt+S), navigate to Tools | Python Integrated Tools, and type the target path in the Path ot Pipenv executable field.

Set pipenv for a new Python project

1. Initiate creating a new Python project as described in Creating a pure Python project.

2. In the New Project dialog, click to expand the Python Interpreter node, select New environment using, and from the list of available virtual environments select Pipenv.

   

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

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

   

5. Click OK to complete the task.

6. If you don't have the base binary directory in PATH, PyCharm shows an error message: Pipenv executable is not found. Discover the proper executable path as described in the pipenv installation procedure and enter the target string in the Pipenv executable field, for example: C:\Users\jetbrains\AppData\Roaming\Python\Python37\Scripts\pipenv.exe (Windows) or /Users/jetbrains/.local/bin/pipenv (macOS).

   Click OK to save the changes and complete the task.

Configure pipenv for an existing Python project

1. Do one of the following:

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

   • Press Ctrl+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 Pipenv Environment.

   

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

5. 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 paste it in the Pipenv executable field.

6. Click OK to complete the task.

Once all the steps are done, the new pipenv environment is set for your project and the packages listed in the Pipfile are installed.

If you open a project with a Pipfile file added but no any interpreter configured, PyCharm offers you to use Pipenv environment.

If you select this option, PyCharm sets pipenv for you automatically. Alternatively, you can click Configure Python interpreter to follow the standard workflow.

Similarly, when you open a project with a Pipfile file in PyCharm for the very first time, for example, by checking it out from the Version Control, the Pipenv virtual environment will be configured automatically.

When you have set the Pipenv virtual environment as a Python interpreter, all available packages are added from the source defined in Pipfile . The packages are installed, removed, and updated in the list of the packages through pipenv rather than through pip.

Create an environment using the Pipfile

1. Open any directory with your source files that contains the Pipenv file: select File | Open from the main menu and choose the directory.

2. If no any environment has been created for this project, PyCharm suggests creating it:

   

3. If PyCharm cannot autodetect the pipenv executable, specify a path to it. Click OK to complete the task.

Once you click OK, PyCharm creates an environment and installs all the required packages.

Note that if you ignore a suggestion to create a pipenv environment, PyCharm won't create a Python interperter for your project. So, any time when you open a .py file, you'll see the warning with the options for configuring a project interpreter: