1<!DOCTYPE html> 2 3<html lang="en" data-content_root="./"> 4 <head> 5 <meta charset="utf-8" /> 6 <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> 7 8 <title>Installing — Paramiko documentation</title> 9 <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=6625fa76" /> 10 <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" /> 11
11<script src="_static/documentation_options.js?v=5929fcd5"></script>
11 12
12<script src="_static/doctools.js?v=888ff710"></script>
12 13
13<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
13 14 <link rel="index" title="Index" href="genindex.html" /> 15 <link rel="search" title="Search" href="search.html" /> 16 <link rel="next" title="Installing (1.x)" href="installing-1.x.html" /> 17 <link rel="prev" title="Frequently Asked/Answered Questions" href="faq.html" /> 18 19 <link rel="stylesheet" href="_static/custom.css" type="text/css" /> 20 21 22 <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> 23 24
24<script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script>
24<meta name="readthedocs-project-slug" content="paramiko-www" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/installing.html" /><meta name="readthedocs-http-status" content="200" /></head><body> 25 26 27 <div class="document"> 28 <div class="documentwrapper"> 29 <div class="bodywrapper"> 30 31 32 <div class="body" role="main"> 33 34 <section id="installing"> 35<h1>Installing<a class="headerlink" href="#installing" title="Link to this heading">¶</a></h1> 36<div class="admonition note"> 37<p class="admonition-title">Note</p> 38<p>These instructions cover Paramiko 2.0 and above. If youâre looking to 39install Paramiko 1.x, see <a class="reference internal" href="installing-1.x.html"><span class="doc">Installing (1.x)</span></a>. However, <strong>the 1.x line 40relies on insecure dependencies</strong> so upgrading is strongly encouraged.</p> 41</div> 42<section id="paramiko-itself"> 43<span id="id1"></span><h2>Paramiko itself<a class="headerlink" href="#paramiko-itself" title="Link to this heading">¶</a></h2> 44<p>The recommended way to get Paramiko is to <strong>install the latest stable release</strong> 45via <a class="reference external" href="http://pip-installer.org">pip</a>:</p> 46<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ pip install paramiko 47</pre></div> 48</div> 49<p>Paramiko has only a few <strong>direct dependencies</strong>:</p> 50<ul class="simple"> 51<li><p>The big one, with its own sub-dependencies, is Cryptography; see <a class="reference internal" href="#cryptography"><span class="std std-ref">its 52specific note below</span></a> for more details;</p></li> 53<li><p><a class="reference external" href="https://pypi.org/project/bcrypt/">bcrypt</a> and <a class="reference external" href="https://pypi.org/project/PyNaCl/">pynacl</a> for Ed25519 key support.</p></li> 54</ul> 55<p>There are also a handful of <strong>optional dependencies</strong> you may install using 56<a class="reference external" href="https://packaging.python.org/tutorials/installing-packages/#installing-setuptools-extras">setuptools âextrasâ</a>:</p> 57<section id="release-lines"> 58<span id="id2"></span><h3>Release lines<a class="headerlink" href="#release-lines" title="Link to this heading">¶</a></h3> 59<p>Users desiring stability may wish to pin themselves to a specific release line 60once they first start using Paramiko; to assist in this, we guarantee bugfixes 61for the last 2-3 releases including the latest stable one.</p> 62<p>This typically spans major & minor versions, so even if e.g. 3.1 is the latest 63stable release, itâs likely that bugfixes will occasionally come out for the 64latest 2.x and perhaps even 1.x releases, as well as for 3.0. New feature 65releases for previous major-version lines are less likely but not unheard of.</p> 66<p>If youâre unsure which version to install:</p> 67<ul class="simple"> 68<li><p><strong>Completely new users</strong> should always default to the <strong>latest stable 69release</strong> (as above, whatever is newest / whatever shows up with <code class="docutils literal notranslate"><span class="pre">pip</span> 70<span class="pre">install</span> <span class="pre">paramiko</span></code>.)</p></li> 71<li><p><strong>Users upgrading from a much older version</strong> (e.g. 1.7.x through 1.10.x) 72should probably get the <strong>oldest actively supported line</strong> (check the 73<a class="reference internal" href="changelog.html"><span class="doc">Changelog</span></a> for recent releases).</p></li> 74<li><p><strong>Everybody else</strong> is hopefully already âonâ a given version and can 75carefully upgrade to whichever version they care to, when their release line 76stops being supported.</p></li> 77</ul> 78</section> 79</section> 80<section id="cryptography"> 81<span id="id3"></span><h2>Cryptography<a class="headerlink" href="#cryptography" title="Link to this heading">¶</a></h2> 82<p><a class="reference external" href="https://cryptography.io">Cryptography</a> provides the low-level (C-based) 83encryption algorithms we need to implement the SSH protocol. It has detailed 84<a class="reference external" href="https://cryptography.io/en/latest/installation.html">installation instructions</a> (and an <a class="reference external" href="https://cryptography.io/en/latest/faq/">FAQ</a>) which you should read carefully.</p> 85<p>In general, youâll need one of the following setups:</p> 86<ul> 87<li><p>On Windows or Mac OS X, provided your <code class="docutils literal notranslate"><span class="pre">pip</span></code> is modern (8.x+): nothing else 88is required. <code class="docutils literal notranslate"><span class="pre">pip</span></code> will install statically compiled binary archives of 89Cryptography & its dependencies.</p></li> 90<li><p>On Linux, or on other platforms with older versions of <code class="docutils literal notranslate"><span class="pre">pip</span></code>: youâll need a 91C build toolchain, plus development headers for Python, OpenSSL and 92<code class="docutils literal notranslate"><span class="pre">libffi</span></code>. Again, see <a class="reference external" href="https://cryptography.io/en/latest/installation.html">Cryptographyâs install docs</a>; these requirements may 93occasionally change.</p> 94<div class="admonition warning"> 95<p class="admonition-title">Warning</p> 96<p>If you go this route, note that <strong>OpenSSL 1.0.1 or newer is effectively 97required</strong>. Cryptography 1.3 and older technically allow OpenSSL 0.9.8, but 981.4 and newer - which Paramiko will gladly install or upgrade, if you e.g. 99<code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-U</span></code> - drop that support.</p> 100</div> 101</li> 102<li><p>Similarly, Cryptography 3.4 and above require Rust language tooling to 103install from source; once again see Cryptographyâs documentation for details 104here, such as <a class="reference external" href="https://cryptography.io/en/latest/installation.html#rust">their Rust install section</a> and <a class="reference external" href="https://cryptography.io/en/latest/faq.html#installing-cryptography-fails-with-error-can-not-find-rust-compiler">this FAQ entry</a>.</p></li> 105</ul> 106</section> 107</section> 108 109 110 </div> 111 112 </div> 113 </div> 114 <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> 115 <div class="sphinxsidebarwrapper"> 116<h1 class="logo"><a href="index.html">Paramiko</a></h1> 117 118 119 120<p class="blurb">A Python implementation of SSHv2.</p> 121 122 123 124 125<p> 126<iframe src="https://ghbtns.com/github-btn.html?user=paramiko&repo=paramiko&type=watch&count=true&size=large&v=2" 127 allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe> 128</p> 129 130 131 132 133 134<h3>Navigation</h3> 135<ul class="current"> 136<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> 137<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQs</a></li> 138<li class="toctree-l1 current"><a class="current reference internal" href="#">Installing</a><ul> 139<li class="toctree-l2"><a class="reference internal" href="#paramiko-itself">
139Paramiko itself</a><ul> 140<li class="toctree-l3"><a class="reference internal" href="#release-lines">Release lines</a></li> 141</ul> 142</li> 143<li class="toctree-l2"><a class="reference internal" href="#cryptography">Cryptography</a></li> 144</ul> 145</li> 146<li class="toctree-l1"><a class="reference internal" href="installing-1.x.html">Installing (1.x)</a></li> 147<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contributing</a></li> 148<li class="toctree-l1"><a class="reference internal" href="contact.html">Contact</a></li> 149</ul> 150 151 152<hr /> 153<ul> 154 155 <li class="toctree-l1"><a href="http://docs.paramiko.org">API Docs</a></li> 156 157</ul> 158 159<div id="searchbox" style="display: none" role="search"> 160 <h3 id="searchlabel">Quick search</h3> 161 <div class="searchformwrapper"> 162 <form class="search" action="search.html" method="get"> 163 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/> 164 <input type="submit" value="Go" /> 165 </form> 166 </div> 167</div>
168<script>document.getElementById('searchbox').style.display = "block"</script>
168 169 170 171<h3 class="donation">Donate/support</h3> 172 173 174 175 176 177 178 179<p> 180Professionally-supported Paramiko is available with the 181<a href="https://tidelift.com/subscription/pkg/pypi-paramiko?utm_source=pypi-paramiko&utm_medium=referral&utm_campaign=docs">Tidelift Subscription</a>. 182</p> 183 184 </div> 185 </div> 186 <div class="clearer"></div> 187 </div> 188 <div class="footer"> 189 ©2026 Jeff Forcier. 190 191 | 192 Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a> 193 & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a> 194 195 | 196 <a href="_sources/installing.rst.txt" 197 rel="nofollow">Page source</a> 198 </div> 199 200 201 202 203
203<script type="text/javascript"> 204 205 var _gaq = _gaq || []; 206 _gaq.push(['_setAccount', 'UA-18486793-2']); 207 _gaq.push(['_setDomainName', 'none']); 208 _gaq.push(['_setAllowLinker', true]); 209 _gaq.push(['_trackPageview']); 210 211 (function() { 212 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; 213 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; 214 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); 215 })(); 216 217 </script>
217 218 219 </body> 220</html>
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.