D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
blackhat.pw
:
/
kunden
/
proc
/
self
/
root
/
usr
/
share
/
doc
/
python3-pip
/
html
/
topics
/
Filename :
configuration.html
back
Copy
<!doctype html> <html class="no-js" lang="en" data-content_root="../"> <head><meta charset="utf-8"/> <meta name="viewport" content="width=device-width,initial-scale=1"/> <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="search" title="Search" href="../search.html" /><link rel="copyright" title="Copyright" href="../copyright.html" /><link rel="next" title="Dependency Resolution" href="dependency-resolution.html" /><link rel="prev" title="Caching" href="caching.html" /> <!-- Generated with Sphinx 8.1.3 and Furo 2024.08.06 --> <title>Configuration - pip documentation v25.1.1</title> <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=ad9e2e31" /> <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" /> <link rel="stylesheet" type="text/css" href="../_static/tabs.css?v=4c969af8" /> <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=4aa03575" /> <style> body { --color-code-background: #f8f8f8; --color-code-foreground: black; } @media not print { body[data-theme="dark"] { --color-code-background: #202020; --color-code-foreground: #d0d0d0; } @media (prefers-color-scheme: dark) { body:not([data-theme="light"]) { --color-code-background: #202020; --color-code-foreground: #d0d0d0; } } } </style></head> <body> <script> document.body.dataset.theme = localStorage.getItem("theme") || "auto"; </script> <svg xmlns="http://www.w3.org/2000/svg" style="display: none;"> <symbol id="svg-toc" viewBox="0 0 24 24"> <title>Contents</title> <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024"> <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> <line x1="3" y1="12" x2="21" y2="12"></line> <line x1="3" y1="6" x2="21" y2="6"></line> <line x1="3" y1="18" x2="21" y2="18"></line> </svg> </symbol> <symbol id="svg-arrow-right" viewBox="0 0 24 24"> <title>Expand</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <symbol id="svg-sun" viewBox="0 0 24 24"> <title>Light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun"> <circle cx="12" cy="12" r="5"></circle> <line x1="12" y1="1" x2="12" y2="3"></line> <line x1="12" y1="21" x2="12" y2="23"></line> <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line> <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line> <line x1="1" y1="12" x2="3" y2="12"></line> <line x1="21" y1="12" x2="23" y2="12"></line> <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line> <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line> </svg> </symbol> <symbol id="svg-moon" viewBox="0 0 24 24"> <title>Dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" /> </svg> </symbol> <symbol id="svg-sun-with-moon" viewBox="0 0 24 24"> <title>Auto light/dark, in light mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-custom-derived-from-feather-sun-and-tabler-moon"> <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/> <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/> <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/> <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/> <line x1="19" y1="14.05" x2="20.414" y2="15.464"/> <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/> <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/> <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/> <line x1="19" y1="5.05" x2="20.414" y2="3.636"/> <circle cx="14.5" cy="9.55" r="3.6"/> </svg> </symbol> <symbol id="svg-moon-with-sun" viewBox="0 0 24 24"> <title>Auto light/dark, in dark mode</title> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-custom-derived-from-feather-sun-and-tabler-moon"> <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/> <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/> <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/> <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/> <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/> <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/> <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/> <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/> <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/> <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/> </svg> </symbol> <symbol id="svg-pencil" viewBox="0 0 24 24"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code"> <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" /> <path d="M13.5 6.5l4 4" /> <path d="M20 21l2 -2l-2 -2" /> <path d="M17 17l-2 2l2 2" /> </svg> </symbol> <symbol id="svg-eye" viewBox="0 0 24 24"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code"> <path stroke="none" d="M0 0h24v24H0z" fill="none" /> <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" /> <path d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" /> <path d="M20 21l2 -2l-2 -2" /> <path d="M17 17l-2 2l2 2" /> </svg> </symbol> </svg> <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> <label class="overlay sidebar-overlay" for="__navigation"> <div class="visually-hidden">Hide navigation sidebar</div> </label> <label class="overlay toc-overlay" for="__toc"> <div class="visually-hidden">Hide table of contents sidebar</div> </label> <a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a> <div class="page"> <header class="mobile-header"> <div class="header-left"> <label class="nav-overlay-icon" for="__navigation"> <div class="visually-hidden">Toggle site navigation sidebar</div> <i class="icon"><svg><use href="#svg-menu"></use></svg></i> </label> </div> <div class="header-center"> <a href="../index.html"><div class="brand">pip documentation v25.1.1</div></a> </div> <div class="header-right"> <div class="theme-toggle-container theme-toggle-header"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-header-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> </header> <aside class="sidebar-drawer"> <div class="sidebar-container"> <div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html"> <span class="sidebar-brand-text">pip documentation v25.1.1</span> </a><form class="sidebar-search-container" method="get" action="../search.html" role="search"> <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search"> <input type="hidden" name="check_keywords" value="yes"> <input type="hidden" name="area" value="default"> </form> <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="../getting-started.html">Getting Started</a></li> <li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li> <li class="toctree-l1"><a class="reference internal" href="../user_guide.html">User Guide</a></li> <li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Topic Guides</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Topic Guides</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current"> <li class="toctree-l2"><a class="reference internal" href="authentication.html">Authentication</a></li> <li class="toctree-l2"><a class="reference internal" href="caching.html">Caching</a></li> <li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Configuration</a></li> <li class="toctree-l2"><a class="reference internal" href="dependency-resolution.html">Dependency Resolution</a></li> <li class="toctree-l2"><a class="reference internal" href="more-dependency-resolution.html">More on Dependency Resolution</a></li> <li class="toctree-l2"><a class="reference internal" href="https-certificates.html">HTTPS Certificates</a></li> <li class="toctree-l2"><a class="reference internal" href="local-project-installs.html">Local project installs</a></li> <li class="toctree-l2"><a class="reference internal" href="repeatable-installs.html">Repeatable Installs</a></li> <li class="toctree-l2"><a class="reference internal" href="secure-installs.html">Secure installs</a></li> <li class="toctree-l2"><a class="reference internal" href="vcs-support.html">VCS Support</a></li> <li class="toctree-l2"><a class="reference internal" href="python-option.html">Managing a different Python interpreter</a></li> <li class="toctree-l2"><a class="reference internal" href="workflow.html">Pip is not a workflow management tool</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../reference/index.html">Reference</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2 has-children"><a class="reference internal" href="../reference/build-system/index.html">Build System Interface</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Build System Interface</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../reference/build-system/pyproject-toml.html"><code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code></a></li> <li class="toctree-l3"><a class="reference internal" href="../reference/build-system/setup-py.html"><code class="docutils literal notranslate"><span class="pre">setup.py</span></code> (legacy)</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../reference/requirement-specifiers.html">Requirement Specifiers</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/requirements-file-format.html">Requirements File Format</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/installation-report.html">Installation Report</a></li> <li class="toctree-l2"><a class="reference internal" href="../reference/inspect-report.html"><code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">inspect</span></code> JSON output specification</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../cli/index.html">Commands</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Commands</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../cli/pip.html">pip</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_install.html">pip install</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_uninstall.html">pip uninstall</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_inspect.html">pip inspect</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_list.html">pip list</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_show.html">pip show</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_freeze.html">pip freeze</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_check.html">pip check</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_lock.html">pip lock</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_download.html">pip download</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_wheel.html">pip wheel</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_hash.html">pip hash</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_search.html">pip search</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_index.html">pip index</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_cache.html">pip cache</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_config.html">pip config</a></li> <li class="toctree-l2"><a class="reference internal" href="../cli/pip_debug.html">pip debug</a></li> </ul> </li> </ul> <p class="caption" role="heading"><span class="caption-text">Project</span></p> <ul> <li class="toctree-l1 has-children"><a class="reference internal" href="../development/index.html">Development</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Development</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../development/getting-started.html">Getting Started</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/contributing.html">Contributing</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/ci.html">Continuous Integration</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/issue-triage.html">Issue Triage</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../development/architecture/index.html">Architecture of pip’s internals</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Architecture of pip’s internals</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../development/architecture/overview.html">Broad functionality overview</a></li> <li class="toctree-l3"><a class="reference internal" href="../development/architecture/anatomy.html">Repository anatomy & directory structure</a></li> <li class="toctree-l3"><a class="reference internal" href="../development/architecture/configuration-files.html">Configuration File Handling</a></li> <li class="toctree-l3"><a class="reference internal" href="../development/architecture/package-finding.html">Finding and choosing files (<code class="docutils literal notranslate"><span class="pre">index</span></code> and <code class="docutils literal notranslate"><span class="pre">PackageFinder</span></code>)</a></li> <li class="toctree-l3"><a class="reference internal" href="../development/architecture/command-line-interface.html">Command Line Interface</a></li> <li class="toctree-l3"><a class="reference internal" href="../development/architecture/upgrade-options.html">Options that control the installation process</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="../development/release-process.html">Release process</a></li> <li class="toctree-l2"><a class="reference internal" href="../development/vendoring-policy.html">Vendoring Policy</a></li> </ul> </li> <li class="toctree-l1 has-children"><a class="reference internal" href="../ux-research-design/index.html">UX Research & Design</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of UX Research & Design</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l2"><a class="reference internal" href="../ux-research-design/contribute.html">How to Contribute</a></li> <li class="toctree-l2"><a class="reference internal" href="../ux-research-design/guidance.html">UX Guidance</a></li> <li class="toctree-l2 has-children"><a class="reference internal" href="../ux-research-design/research-results/index.html">UX Research Results</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of UX Research Results</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/about-our-users.html">About pip’s Users</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/mental-models.html">How Users Understand pip</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/users-and-security.html">How pip users think about security</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/ci-cd.html">How pip is used in interactive environments (i.e. CI, CD)</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/personas.html">pip Personas</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/prioritizing-features.html">Prioritizing pip Features</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/override-conflicting-dependencies.html">Providing an override to install packages with conflicting dependencies</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/pip-force-reinstall.html">pip --force-reinstall</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/pip-search.html">pip search</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/pip-upgrade-conflict.html">pip Upgrade Conflict</a></li> <li class="toctree-l3"><a class="reference internal" href="../ux-research-design/research-results/improving-pips-documentation.html">Improving pip’s Documentation</a></li> </ul> </li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="../news.html">Changelog</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md">Code of Conduct</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/pypa/pip">GitHub</a></li> </ul> </div> </div> </div> </div> </aside> <div class="main"> <div class="content"> <div class="article-container"> <a href="#" class="back-to-top muted-link"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> </svg> <span>Back to top</span> </a> <div class="content-icon-container"> <div class="view-this-page"> <a class="muted-link" href="../_sources/topics/configuration.md.txt" title="View this page"> <svg><use href="#svg-eye"></use></svg> <span class="visually-hidden">View this page</span> </a> </div> <div class="theme-toggle-container theme-toggle-content"> <button class="theme-toggle"> <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> </button> </div> <label class="toc-overlay-icon toc-content-icon" for="__toc"> <div class="visually-hidden">Toggle table of contents sidebar</div> <i class="icon"><svg><use href="#svg-toc"></use></svg></i> </label> </div> <article role="main" id="furo-main-content"> <section id="configuration"> <span id="id1"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Link to this heading">¶</a></h1> <p>pip allows a user to change its behaviour via 3 mechanisms:</p> <ul class="simple"> <li><p>command line options</p></li> <li><p>environment variables</p></li> <li><p>configuration files</p></li> </ul> <p>This page explains how the configuration files and environment variables work, and how they are related to pip’s various command line options.</p> <div class="admonition seealso"> <p class="admonition-title">See also</p> <p><a class="reference internal" href="../cli/pip_config.html"><span class="doc">pip config</span></a> command, which helps manage pip’s configuration.</p> </div> <section id="configuration-files"> <span id="config-file"></span><h2>Configuration Files<a class="headerlink" href="#configuration-files" title="Link to this heading">¶</a></h2> <p>Configuration files can change the default values for command line options. The files are written using standard INI format.</p> <p>pip has 3 “levels” of configuration files:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">global</span></code>: system-wide configuration file, shared across users.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">user</span></code>: per-user configuration file.</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">site</span></code>: per-environment configuration file; i.e. per-virtualenv.</p></li> </ul> <p>Additionally, environment variables can be specified which will override any of the above.</p> <section id="location"> <h3>Location<a class="headerlink" href="#location" title="Link to this heading">¶</a></h3> <p>pip’s configuration files are located in fairly standard locations. This location is different on different operating systems, and has some additional complexity for backwards compatibility reasons. Note that if user config files exist in both the legacy and current locations, values in the current file will override values in the legacy file.</p> <div class="tab-set docutils"> <input checked="True" class="tab-input" id="tab-set--0-input--1" name="tab-set--0" type="radio"><label class="tab-label" for="tab-set--0-input--1">Unix</label><div class="tab-content docutils"> <dl class="simple myst"> <dt>Global</dt><dd><p>In a “pip” subdirectory of any of the paths set in the environment variable <code class="docutils literal notranslate"><span class="pre">XDG_CONFIG_DIRS</span></code> (if it exists), for example <code class="file docutils literal notranslate"><span class="pre">/etc/xdg/pip/pip.conf</span></code>.</p> <p>This will be followed by loading <code class="file docutils literal notranslate"><span class="pre">/etc/pip.conf</span></code>.</p> </dd> <dt>User</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">$HOME/.config/pip/pip.conf</span></code>, which respects the <code class="docutils literal notranslate"><span class="pre">XDG_CONFIG_HOME</span></code> environment variable.</p> <p>The legacy “per-user” configuration file is also loaded, if it exists: <code class="file docutils literal notranslate"><span class="pre">$HOME/.pip/pip.conf</span></code>.</p> </dd> <dt>Site</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">$VIRTUAL_ENV/pip.conf</span></code></p> </dd> </dl> </div> <input class="tab-input" id="tab-set--0-input--2" name="tab-set--0" type="radio"><label class="tab-label" for="tab-set--0-input--2">MacOS</label><div class="tab-content docutils"> <dl class="simple myst"> <dt>Global</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">/Library/Application</span> <span class="pre">Support/pip/pip.conf</span></code></p> </dd> <dt>User</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">$HOME/Library/Application</span> <span class="pre">Support/pip/pip.conf</span></code> if directory <code class="docutils literal notranslate"><span class="pre">$HOME/Library/Application</span> <span class="pre">Support/pip</span></code> exists else <code class="file docutils literal notranslate"><span class="pre">$HOME/.config/pip/pip.conf</span></code></p> <p>The legacy “per-user” configuration file is also loaded, if it exists: <code class="file docutils literal notranslate"><span class="pre">$HOME/.pip/pip.conf</span></code>.</p> </dd> <dt>Site</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">$VIRTUAL_ENV/pip.conf</span></code></p> </dd> </dl> </div> <input class="tab-input" id="tab-set--0-input--3" name="tab-set--0" type="radio"><label class="tab-label" for="tab-set--0-input--3">Windows</label><div class="tab-content docutils"> <dl class="simple myst"> <dt>Global</dt><dd><ul class="simple"> <li><p>On Windows 7 and later: <code class="file docutils literal notranslate"><span class="pre">C:\ProgramData\pip\pip.ini</span></code> (hidden but writeable)</p></li> <li><p>On Windows Vista: Global configuration is not supported.</p></li> <li><p>On Windows XP: <code class="file docutils literal notranslate"><span class="pre">C:\Documents</span> <span class="pre">and</span> <span class="pre">Settings\All</span> <span class="pre">Users\Application</span> <span class="pre">Data\pip\pip.ini</span></code></p></li> </ul> </dd> <dt>User</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">%APPDATA%\pip\pip.ini</span></code></p> <p>The legacy “per-user” configuration file is also loaded, if it exists: <code class="file docutils literal notranslate"><span class="pre">%HOME%\pip\pip.ini</span></code></p> </dd> <dt>Site</dt><dd><p><code class="file docutils literal notranslate"><span class="pre">%VIRTUAL_ENV%\pip.ini</span></code></p> </dd> </dl> </div> </div> </section> <section id="pip-config-file"> <h3><code class="docutils literal notranslate"><span class="pre">PIP_CONFIG_FILE</span></code><a class="headerlink" href="#pip-config-file" title="Link to this heading">¶</a></h3> <p>Additionally, the environment variable <code class="docutils literal notranslate"><span class="pre">PIP_CONFIG_FILE</span></code> can be used to specify a configuration file that’s loaded last, and whose values override the values set in the aforementioned files. Setting this to <a class="reference external" href="https://docs.python.org/3/library/os.html#os.devnull" title="(in Python v3.13)"><code class="xref any docutils literal notranslate"><span class="pre">os.devnull</span></code></a> disables the loading of <em>all</em> configuration files. Note that if a file exists at the location that this is set to, the user config file will not be loaded.</p> </section> <section id="loading-order"> <span id="config-precedence"></span><h3>Loading order<a class="headerlink" href="#loading-order" title="Link to this heading">¶</a></h3> <p>When multiple configuration files are found, pip combines them in the following order:</p> <ul class="simple"> <li><p>Global</p></li> <li><p>User</p></li> <li><p>Site</p></li> <li><p><code class="docutils literal notranslate"><span class="pre">PIP_CONFIG_FILE</span></code>, if given.</p></li> </ul> <p>Each file read overrides any values read from previous files, so if the global timeout is specified in both the global file and the per-user file then the latter value will be used.</p> </section> <section id="naming"> <h3>Naming<a class="headerlink" href="#naming" title="Link to this heading">¶</a></h3> <p>The names of the settings are derived from the long command line option.</p> <p>As an example, if you want to use a different package index (<code class="docutils literal notranslate"><span class="pre">--index-url</span></code>) and set the HTTP timeout (<code class="docutils literal notranslate"><span class="pre">--timeout</span></code>) to 60 seconds, your config file would look like this:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[global]</span> <span class="na">timeout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">60</span> <span class="na">index-url</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">https://download.zope.org/ppix</span> </pre></div> </div> </section> <section id="per-command-section"> <h3>Per-command section<a class="headerlink" href="#per-command-section" title="Link to this heading">¶</a></h3> <p>Each subcommand can be configured optionally in its own section. This overrides the global setting with the same name.</p> <p>As an example, if you want to decrease the <code class="docutils literal notranslate"><span class="pre">timeout</span></code> to <code class="docutils literal notranslate"><span class="pre">10</span></code> seconds when running the <a class="reference internal" href="../cli/pip_freeze.html#pip-freeze"><span class="std std-ref">pip freeze</span></a>, and use <code class="docutils literal notranslate"><span class="pre">60</span></code> seconds for all other commands:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[global]</span> <span class="na">timeout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">60</span> <span class="k">[freeze]</span> <span class="na">timeout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">10</span> </pre></div> </div> </section> <section id="boolean-options"> <h3>Boolean options<a class="headerlink" href="#boolean-options" title="Link to this heading">¶</a></h3> <p>Boolean options like <code class="docutils literal notranslate"><span class="pre">--ignore-installed</span></code> or <code class="docutils literal notranslate"><span class="pre">--no-dependencies</span></code> can be set like this:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[install]</span> <span class="na">ignore-installed</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">true</span> <span class="na">no-dependencies</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">yes</span> </pre></div> </div> <p>To enable the boolean options <code class="docutils literal notranslate"><span class="pre">--no-compile</span></code>, <code class="docutils literal notranslate"><span class="pre">--no-warn-script-location</span></code> and <code class="docutils literal notranslate"><span class="pre">--no-cache-dir</span></code>, falsy values have to be used:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[global]</span> <span class="na">no-cache-dir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">false</span> <span class="k">[install]</span> <span class="na">no-compile</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">no</span> <span class="na">no-warn-script-location</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">false</span> </pre></div> </div> </section> <section id="repeatable-options"> <h3>Repeatable options<a class="headerlink" href="#repeatable-options" title="Link to this heading">¶</a></h3> <p>For options which can be repeated like <code class="docutils literal notranslate"><span class="pre">--verbose</span></code> and <code class="docutils literal notranslate"><span class="pre">--quiet</span></code>, a non-negative integer can be used to represent the level to be specified:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[global]</span> <span class="na">quiet</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">0</span> <span class="na">verbose</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">2</span> </pre></div> </div> <p>It is possible to append values to a section within a configuration file. This is applicable to appending options like <code class="docutils literal notranslate"><span class="pre">--find-links</span></code> or <code class="docutils literal notranslate"><span class="pre">--trusted-host</span></code>, which can be written on multiple lines:</p> <div class="highlight-ini notranslate"><div class="highlight"><pre><span></span><span class="k">[global]</span> <span class="na">find-links</span><span class="w"> </span><span class="o">=</span> <span class="w"> </span><span class="na">http</span><span class="o">:</span><span class="s">//download.example.com</span> <span class="k">[install]</span> <span class="na">find-links</span><span class="w"> </span><span class="o">=</span> <span class="w"> </span><span class="na">http</span><span class="o">:</span><span class="s">//mirror1.example.com</span> <span class="w"> </span><span class="na">http</span><span class="o">:</span><span class="s">//mirror2.example.com</span> <span class="na">trusted-host</span><span class="w"> </span><span class="o">=</span> <span class="w"> </span><span class="na">mirror1.example.com</span> <span class="w"> </span><span class="na">mirror2.example.com</span> </pre></div> </div> <p>This enables users to add additional values in the order of entry for such command line arguments.</p> </section> </section> <section id="environment-variables"> <h2>Environment Variables<a class="headerlink" href="#environment-variables" title="Link to this heading">¶</a></h2> <p>pip’s command line options can be set with environment variables using the format <code class="docutils literal notranslate"><span class="pre">PIP_<UPPER_LONG_NAME></span></code> . Dashes (<code class="docutils literal notranslate"><span class="pre">-</span></code>) have to be replaced with underscores (<code class="docutils literal notranslate"><span class="pre">_</span></code>).</p> <ul> <li><p><code class="docutils literal notranslate"><span class="pre">PIP_TIMEOUT=60</span></code> is the same as <code class="docutils literal notranslate"><span class="pre">--timeout=60</span></code></p></li> <li><div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">PIP_FIND_LINKS</span><span class="o">=</span><span class="s2">"http://mirror1.example.com http://mirror2.example.com"</span> </pre></div> </div> <p>is the same as</p> <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">--</span><span class="n">find</span><span class="o">-</span><span class="n">links</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">mirror1</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> <span class="o">--</span><span class="n">find</span><span class="o">-</span><span class="n">links</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">mirror2</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span> </pre></div> </div> </li> </ul> <p>Repeatable options that do not take a value (such as <code class="docutils literal notranslate"><span class="pre">--verbose</span></code>) can be specified using the number of repetitions:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">PIP_VERBOSE=3</span></code> is the same as <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-vvv</span></code></p></li> </ul> <div class="admonition note"> <p class="admonition-title">Note</p> <p>Environment variables set to an empty string (like with <code class="docutils literal notranslate"><span class="pre">export</span> <span class="pre">X=</span></code> on Unix) will <strong>not</strong> be treated as false. Use <code class="docutils literal notranslate"><span class="pre">no</span></code>, <code class="docutils literal notranslate"><span class="pre">false</span></code> or <code class="docutils literal notranslate"><span class="pre">0</span></code> instead.</p> </div> </section> <section id="precedence-override-order"> <h2>Precedence / Override order<a class="headerlink" href="#precedence-override-order" title="Link to this heading">¶</a></h2> <p>Command line options override environment variables, which override the values in a configuration file. Within the configuration file, values in command-specific sections override values in the global section.</p> <p>Examples:</p> <ul class="simple"> <li><p><code class="docutils literal notranslate"><span class="pre">--host=foo</span></code> overrides <code class="docutils literal notranslate"><span class="pre">PIP_HOST=foo</span></code></p></li> <li><p><code class="docutils literal notranslate"><span class="pre">PIP_HOST=foo</span></code> overrides a config file with <code class="docutils literal notranslate"><span class="pre">[global]</span> <span class="pre">host</span> <span class="pre">=</span> <span class="pre">foo</span></code></p></li> <li><p>A command specific section in the config file <code class="docutils literal notranslate"><span class="pre">[<command>]</span> <span class="pre">host</span> <span class="pre">=</span> <span class="pre">bar</span></code> overrides the option with same name in the <code class="docutils literal notranslate"><span class="pre">[global]</span></code> config file section.</p></li> </ul> </section> </section> </article> </div> <footer> <div class="related-pages"> <a class="next-page" href="dependency-resolution.html"> <div class="page-info"> <div class="context"> <span>Next</span> </div> <div class="title">Dependency Resolution</div> </div> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> </a> <a class="prev-page" href="caching.html"> <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> <div class="page-info"> <div class="context"> <span>Previous</span> </div> <div class="title">Caching</div> </div> </a> </div> <div class="bottom-of-page"> <div class="left-details"> <div class="copyright"> <a href="../copyright.html">Copyright</a> © The pip developers </div> Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s <a href="https://github.com/pradyunsg/furo">Furo</a> </div> <div class="right-details"> </div> </div> </footer> </div> <aside class="toc-drawer"> <div class="toc-sticky toc-scroll"> <div class="toc-title-container"> <span class="toc-title"> On this page </span> </div> <div class="toc-tree-container"> <div class="toc-tree"> <ul> <li><a class="reference internal" href="#">Configuration</a><ul> <li><a class="reference internal" href="#configuration-files">Configuration Files</a><ul> <li><a class="reference internal" href="#location">Location</a></li> <li><a class="reference internal" href="#pip-config-file"><code class="docutils literal notranslate"><span class="pre">PIP_CONFIG_FILE</span></code></a></li> <li><a class="reference internal" href="#loading-order">Loading order</a></li> <li><a class="reference internal" href="#naming">Naming</a></li> <li><a class="reference internal" href="#per-command-section">Per-command section</a></li> <li><a class="reference internal" href="#boolean-options">Boolean options</a></li> <li><a class="reference internal" href="#repeatable-options">Repeatable options</a></li> </ul> </li> <li><a class="reference internal" href="#environment-variables">Environment Variables</a></li> <li><a class="reference internal" href="#precedence-override-order">Precedence / Override order</a></li> </ul> </li> </ul> </div> </div> </div> </aside> </div> </div><script src="../_static/documentation_options.js?v=22103397"></script> <script src="../_static/doctools.js?v=9bcbadda"></script> <script src="../_static/sphinx_highlight.js?v=dc90522c"></script> <script type="module" src="../_static/scripts/furo.js?v=d32f1409"></script> <script src="../_static/clipboard.min.js?v=66b4909c"></script> <script src="../_static/copybutton.js?v=80126f2a"></script> <script src="../_static/tabs.js?v=3ee01567"></script> </body> </html>