Set up a working environment

1. Ensure that you have downloaded and installed Python on your computer.

   Installing Python on Windows from Microsoft Store

   If you are on Windows, you can download Python from the Microsoft Store and install it as a Python interpreter. Once the Python application is downloaded from the Microsoft Store, it becomes available in the list of the Python executables.

   Note that interpreters added from the Microsoft Store installations come with some limitations. Because of restrictions on Microsoft Store apps, Python scripts may not have full write access to shared locations such as TEMP and the registry.

2. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

3. Select Add Local Interpreter.

4. In the left-hand pane of the Add Python Interpreter dialog, select System Interpreter.

   

5. In the Interpreter drop-down, select one of the Python interpreters that have been installed in your system, or click and in the Select Python Interpreter dialog that opens, choose the desired Python executable.

   

   You will need admin privileges to install, remove, and upgrade packages for the system interpreter. When attempting to install an interpreter package through an intention action, you might receive the following error message:

   

   As prompted, consider using a virtual environment for your project.

6. Click OK to complete the task.

For more information, refer to Configure a system interpreter.

1. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

2. Select Add Local Interpreter.

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

   

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

   New virtual environment

   • Specify the location of the new virtual environment in the Location field, or click 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 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.

   Existing virtual environment

   • Choose the desired interpreter from the list.

   • If the desired interpreter is not on the list, click , and then browse for the desired Python executable (for example, venv/bin/python on macOS or venv\Scripts\python.exe on Windows).

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

5. Click OK to complete the task.

note

If DataSpell displays the Invalid environment warning, it means that the specified Python binary cannot be found in the file system, or the Python version is not supported. Check the Python path and install a new version, if needed.

For more information, refer to Configure a virtual environment.

1. Ensure that Anaconda or Miniconda is downloaded and installed on your computer, and you're aware of a path to its executable file.

   For more information, refer to the installation instructions.

2. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

3. Select Add Local Interpreter.

4. In the left-hand pane of the Add Python Interpreter dialog, select Conda Environment.

   

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

   New conda environment

   • Select the Python version from the list.

   • Normally, DataSpell will detect conda installation.

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

   • Specify the environment name.

   Existing conda environment

   • Select the environment from the list.

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

6. Click OK to complete the task.

For more information, refer to Configure a conda virtual environment.

1. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

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 your project contains Pipfile, you can choose whether you want to install the packages listed in it by enabling or disabling the Install packages from Pipfile checkbox. By default, the checkbox is enabled.

6. 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.

7. Click OK to complete the task.

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.

For more information, refer to Configure a pipenv environment.

1. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

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 your project contains pyproject.toml, you can choose whether you want to install the packages listed in it by enabling or disabling the Install packages from pyproject.toml checkbox. By default, the checkbox is enabled.

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

     macOS

     Windows

     Linux

     /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.

For more information, refer to Configure a Poetry environment.

1. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

2. Select On WSL.

3. Wait until DataSpell detects Linux on your machine and completes introspection. Click Next to proceed:

   

4. In the left-hand pane of the dialog, select the type of the WSL interpreter you want to create: Virtual Environment, Conda Environment, or System Interpreter.

   

   For a system interpreter, just provide the path to the Python executable in the selected Linux distribution.

   For virtual and conda environments, you can provide a path to a Python executable of an existing environment in the selected Linux distribution or create a new environment based on the specified Python.

Once done, the new interpreter will be added to your project, and the default mnt mappings will be set.

For more information, refer to Configure an interpreter using WSL.

1. Ensure that there is an SSH server running on a remote host, since DataSpell runs remote interpreters via ssh-sessions.

2. Do one of the following:

   • Press CtrlAlt0S to open Settings and go to Project: workspace | 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.

   • In the context menu of an attached directory, select Interpreter.

3. Select On SSH.

4. Select an option to create a new SSH connection, then specify server information (host, port, and username).

   

   Alternatively, you can select Existing and choose any available SSH configuration from the list. To create a new SSH configuration, follow the steps below:

   Creating an SSH configuration

   • Click next to the list of configurations:

     

   • Click, disable the Visible only for this project checkbox, and fill in the required fields:

     

   • Once done, the newly created SSH configuration will appear in the list of available configurations. Click Next to proceed:

     

5. In the next dialog window, provide the authentication details to connect to the target server.

   

   Select Password or Key pair (OpenSSH or PuTTY) and enter your password or passphrase. If Key pair (OpenSSH or PuTTY) is selected, specify:

   • Private key: location of the file with a private key

   • Passphrase: similar to a password, it serves to encrypt the private key.

   Click Next to proceed.

6. Wait until DataSpell completes the introspection of the SSH server.

   

7. In the next dialog, select a type of Python environment to configure on the SSH server.

   

   You can create a new virtual environment or сonda environment, select an existing one, or use a system interpreter.

   • 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.

   • If you need to execute your Python code on the SSH server as a sudo user, enable the Execute code with root privileges via sudo checkbox.

   • DataSpell can automatically synchronize files with the remote host. To do that, select the Automatically upload files to remote host checkbox, and specify the root directory for synchronization in Root directory. If the directory doesn't exist, it will be created.

     When this option is enabled, the attached directories that have been configured to use the SSH interpreter are uploaded to the root directory on the remote host. Then they are synced upon any of the following events:

     • Applying changes to files

     • Switching to this interpreter

     • IDE start-up

   • You can exclude files that do need to be synchronized. To do that, specify the glob patterns in the Excluded paths field. By default, the field contains some patterns for directories and files that are not required for running a remote interpreter.

   Click Create to complete adding the interpreter.

For more information, refer to Configure an interpreter using SSH.