<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>Installation — pyOpenSSL 16.1.0 documentation</title> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html"/> <link rel="search" title="Search" href="search.html"/> <link rel="top" title="pyOpenSSL 16.1.0 documentation" href="index.html"/> <link rel="next" title="OpenSSL — Python interface to OpenSSL" href="api.html"/> <link rel="prev" title="Introduction" href="introduction.html"/> <script src="_static/js/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="index.html" class="icon icon-home"> pyOpenSSL </a> <div class="version"> 16.1.0 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul> <li class="toctree-l2"><a class="reference internal" href="#documentation">Documentation</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="api.html"><code class="docutils literal"><span class="pre">OpenSSL</span></code> — Python interface to OpenSSL</a></li> <li class="toctree-l1"><a class="reference internal" href="internals.html">Internals</a></li> </ul> <ul> <li class="toctree-l1"><a class="reference internal" href="backward-compatibility.html">Backward Compatibility</a></li> <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">pyOpenSSL</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html">Docs</a> »</li> <li>Installation</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/install.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="installation"> <h1>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h1> <p>To install pyOpenSSL:</p> <div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install pyopenssl </pre></div> </div> <p>If you are installing in order to <em>develop</em> on pyOpenSSL, move to the root directory of a pyOpenSSL checkout, and run:</p> <div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install -e . </pre></div> </div> <div class="admonition warning"> <p class="first admonition-title">Warning</p> <p>As of 0.14, pyOpenSSL is a pure-Python project. That means that if you encounter <em>any</em> kind of compiler errors, pyOpenSSL’s bugtracker is the <strong>wrong</strong> place to report them because we <em>cannot</em> help you.</p> <p class="last">Please take the time to read the errors and report them/ask help from the appropriate project. The most likely culprit being <a class="reference external" href="https://cryptography.io/">cryptography</a> that contains OpenSSL’s library bindings.</p> </div> <div class="section" id="documentation"> <h2>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h2> <p>The documentation is written in reStructuredText and built using Sphinx:</p> <div class="highlight-default"><div class="highlight"><pre><span></span>$ cd doc $ make html </pre></div> </div> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="api.html" class="btn btn-neutral float-right" title="OpenSSL — Python interface to OpenSSL" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="introduction.html" class="btn btn-neutral" title="Introduction" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2001-2017, The pyOpenSSL developers. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'16.1.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>