Synchronizing and Sharing Settings
In this section:
- Synchronizing settings
- What is synched?
- Connecting to Settings Repository
- Configuring login to Settings Repository
- Sharing settings
Before you start working with Settings Repository, make sure that the Settings Repository plugin is downloaded and enabled, as described in Installing, Updating and Uninstalling Plugins.
PyCharm makes it possible to synchronize settings across several different PyCharm installations, or auto-configure new installations, using settings from the server.
Once logged in, the settings are synchronized with the server based on "updated" timestamp stored in each settings group. The most recent ones are used and are either sent to server or applied locally from the server.
PyCharm always works with settings stored locally. So, the local settings are used, if, at some moment, the server is not available. On the following connection all updated settings will be pushed to the server.
When logged in to the server, once some settings are updated locally inside PyCharm, they are subsequently sent to the server. But local settings are only updated on PyCharm startup.
The server stores only one set of settings for each user.
What is synched?
Settings Repository stores almost all of the IDE and project settings, except for some platform-specific ones, and those containing local paths. This includes code style settings, keymaps, fonts and colors scheme, inspection profiles, and others.
Connecting to Settings Repository
- During the first PyCharm startup after installing the plugin, through the Login to IntelliJ Configuration Server dialog box.
- At any time during a session through the Login to IntelliJ Configuration Server dialog box.
- During PyCharm startup according to the previously configured settings:
- Through the Login to IntelliJ Configuration Server dialog box
To connect to the Settings Repository during a session
- At any time during a session, click the IntelliJ Configuration Server Status button ( when connected to the server, or , when disconnected) on the Status bar.
- In the dialog box that opens, click the Login button.
- Specify the login and password of your JetBrains Account or create a
JetBrains Account if you do not have it.
To connect to the IntelliJ Configuration Server through a Proxy server, select the Use HTTP Proxy check box and specify the Proxy server parameters in the dialog box controls. See a detailed description of controls in the Login to IntelliJ Configuration Server dialog box reference.
Configuring login to Settings Repository
To configure login to the Server during the next PyCharm startup
- Click the IntelliJ Configuration Server Status button / on the Status bar.
- In the dialog box that opens, specify whether you want to log in to the IntelliJ Configuration Server during the next startup and how you want to do it.
The following options are available:
- Show login dialog box
- Login silently
- Do not login
For sharing project settings,
.idea project configuration directory should be shared via version control.
If you decide to share PyCharm project files with the other developers, follow these guidelines.
Directory based project format (
.idea directory) is used by all the
PyCharm versions by default. Here is what you need to share:
- All the files under
.ideadirectory in the project root, except the
tasks.xmlfiles, which store user-specific settings.
Be careful about sharing the following:
You may consider not to share the following: