Merge pull request #582 from TC01/dotconfig

XDG compliance for Unix/Linux (~/.config)

AUTHORS.txt

@@ -5,6 +5,7 @@ Andrey Bulgakov
 Antti Kaihola
 Armin Ronacher
 Aziz Köksal
+Ben Rosser
 Brian Rosner
 Carl Meyer
 Chris McDonough

docs/configuration.txt

@@ -84,7 +84,8 @@ Location
 The names and locations of the configuration files vary slightly across
 platforms.
 
-On Unix and Mac OS X the configuration file is: :file:`$HOME/.pip/pip.conf`
+On Unix and Mac OS X the configuration file is: 
+:file:`$HOME/.config/pip/pip.conf`
 
 And on Windows, the configuration file is: :file:`%HOME%\\pip\\pip.ini`
 

docs/news.txt

@@ -56,7 +56,10 @@ develop (unreleased)
   Hsiaoming Yang and Markus Hametner.
 
 * Use a temporary directory as the default build location outside of a
-  virtualenv. Fixes issues #339 and #381. Thanks TC01.
+  virtualenv. Fixes issues #339 and #381. Thanks Ben Rosser.
+
+* Moved pip configuration data to ~/.config/pip, the XDG standard for config
+  files on Unix/Linux systems. Thanks Ben Rosser.
 
 * Added support for specifying extras with local editables. Thanks Nick
   Stenning.

pip/locations.py

@@ -3,6 +3,7 @@
 import sys
 import site
 import os
+import shutil
 import tempfile
 from pip.backwardcompat import get_python_lib
 
@@ -60,9 +61,29 @@ def virtualenv_no_global():
     default_log_file = os.path.join(default_storage_dir, 'pip.log')
 else:
     bin_py = os.path.join(sys.prefix, 'bin')
-    default_storage_dir = os.path.join(user_dir, '.pip')
+
+    # Use XDG_CONFIG_HOME instead of the ~/.pip
+    # On some systems, we may have to create this, on others it probably exists
+    xdg_dir = os.path.join(user_dir, '.config')
+    xdg_dir = os.environ.get('XDG_CONFIG_HOME', xdg_dir)
+    if not os.path.exists(xdg_dir):
+        os.mkdir(xdg_dir)
+    default_storage_dir = os.path.join(xdg_dir, 'pip')
     default_config_file = os.path.join(default_storage_dir, 'pip.conf')
     default_log_file = os.path.join(default_storage_dir, 'pip.log')
+
+    # Migration path for users- move things from the old dir if it exists
+    # If the new dir exists and has no pip.conf and the old dir does, move it
+    # When these checks are finished, delete the old directory
+    old_storage_dir = os.path.join(user_dir, '.pip')
+    old_config_file = os.path.join(old_storage_dir, 'pip.conf')
+    if os.path.exists(old_storage_dir):
+        if not os.path.exists(default_storage_dir):
+            shutil.copytree(old_storage_dir, default_storage_dir)
+        elif os.path.exists(old_config_file) and not os.path.exists(default_config_file):
+            shutil.copy2(old_config_file, default_config_file)
+        shutil.rmtree(old_storage_dir)
+
     # Forcing to use /usr/local/bin for standard Mac OS X framework installs
     # Also log to ~/Library/Logs/ for use with the Console.app log viewer
     if sys.platform[:6] == 'darwin' and sys.prefix[:16] == '/System/Library/':