<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Welcome to Stem! — Stem 1.1.0 documentation</title>
<link rel="stylesheet" href="_static/haiku.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/print.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.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/theme_extras.js"></script>
<link rel="shortcut icon" href="_static/favicon.png"/>
<link rel="top" title="Stem 1.1.0 documentation" href="#" />
<link rel="next" title="Contents" href="contents.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="_static/logo.png" alt="Logo"/><h1 class="heading"><a href="#">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>Welcome to Stem!</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="#">Home</a></li>
<li><a href="tutorials.html">Tutorials</a>
<ul>
<li><a href="tutorials/the_little_relay_that_could.html">Hello World</a></li>
<li><a href="tutorials/to_russia_with_love.html">Client Usage</a></li>
<li><a href="tutorials/tortoise_and_the_hare.html">Event Listening</a></li>
<li><a href="tutorials/mirror_mirror_on_the_wall.html">Tor Descriptors</a></li>
<li><a href="tutorials/east_of_the_sun.html">Utilities</a></li>
<li><a href="tutorials/double_double_toil_and_trouble.html">Examples</a></li>
</ul>
</li>
<li><a href="api.html">API</a>
<ul>
<li><a href="api/control.html">stem.control</a></li>
<li><a href="api/connection.html">stem.connection</a></li>
<li><a href="api/socket.html">stem.socket</a></li>
<li><a href="api/process.html">stem.process</a></li>
<li><a href="api/response.html">stem.response</a></li>
<li><a href="api/exit_policy.html">stem.exit_policy</a></li>
<li><a href="api/version.html">stem.version</a></li>
<li><a href="api.html#descriptors">Descriptors</a></li>
<li><a href="api.html#utilities">Utilities</a></li>
</ul>
</li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development</a>
<ul>
<li><a href="faq.html">FAQ</a></li>
<li><a href="change_log.html">Change Log</a></li>
<li><a href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs">Bug Tracker</a></li>
<li><a href="download.html">Download</a></li>
</ul>
</li>
</ul>
</p>
</div>
<div class="content">
<div class="section" id="welcome-to-stem">
<h1>Welcome to Stem!<a class="headerlink" href="#welcome-to-stem" title="Permalink to this headline">¶</a></h1>
<p>Stem is a python controller library for <a class="reference external" href="https://www.torproject.org/">Tor</a>. Like its predecessor, <a class="reference external" href="https://gitweb.torproject.org/pytorctl.git">TorCtl</a>, it uses Tor’s <a class="reference external" href="https://gitweb.torproject.org/torspec.git/blob/HEAD:/control-spec.txt">control protocol</a> to help developers program against the Tor process, enabling them to build things similar to <a class="reference external" href="https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia">Vidalia</a> and <a class="reference external" href="https://www.atagar.com/arm/">arm</a>.</p>
<a class="reference external image-reference" href="tutorials.html"><img alt="_images/tutorials.png" src="_images/tutorials.png" /></a>
<a class="reference external image-reference" href="api.html"><img alt="_images/api.png" src="_images/api.png" /></a>
<a class="reference external image-reference" href="faq.html"><img alt="_images/faq.png" src="_images/faq.png" /></a>
<a class="reference external image-reference" href="change_log.html"><img alt="_images/change_log.png" src="_images/change_log.png" /></a>
<a class="reference external image-reference" href="https://trac.torproject.org/projects/tor/wiki/doc/stem/bugs"><img alt="_images/bug_tracker.png" src="_images/bug_tracker.png" /></a>
<a class="reference external image-reference" href="download.html"><img alt="_images/download.png" src="_images/download.png" /></a>
</div>
<div class="section" id="subsections">
<h1>Subsections<a class="headerlink" href="#subsections" title="Permalink to this headline">¶</a></h1>
<ul class="simple">
<li><a class="reference external" href="https://trac.torproject.org/projects/tor/wiki/doc/stem">Development Wiki</a></li>
<li><a class="reference external" href="https://www.atagar.com/contact/">Contact</a></li>
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="py-modindex.html"><em>Module Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
<li><a class="reference external" href="https://jenkins.torproject.org/job/stem-tor-ci/">Automated Testing</a></li>
</ul>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="contents.html">Contents</a></li>
</ul>
</div>
</div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
