<!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>Change Log — 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="index.html" />
<link rel="up" title="Contents" href="contents.html" />
<link rel="next" title="Download" href="download.html" />
<link rel="prev" title="Double Double Toil and Trouble" href="tutorials/double_double_toil_and_trouble.html" />
</head>
<body>
<div class="header"><img class="rightlogo" src="_static/logo.png" alt="Logo"/><h1 class="heading"><a href="index.html">
<span>Stem Docs</span></a></h1>
<h2 class="heading"><span>Change Log</span></h2>
</div>
<div class="topnav">
<p>
<ul id="navbar">
<li><a href="index.html">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</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="change-log">
<h1>Change Log<a class="headerlink" href="#change-log" title="Permalink to this headline">¶</a></h1>
<p>The following is a log of all user-facing changes to stem, both released and
unreleased. For a monthly report on work being done see my <a class="reference external" href="https://www.atagar.com/log.php">development log</a>.</p>
<ul class="simple">
<li><a class="reference internal" href="#versioning"><em>Versioning</em></a></li>
<li><a class="reference internal" href="#unreleased"><em>Unreleased</em></a></li>
<li><a class="reference internal" href="#version-1-0"><em>Version 1.0</em></a></li>
</ul>
<div class="section" id="versioning">
<span id="id1"></span><h2>Versioning<a class="headerlink" href="#versioning" title="Permalink to this headline">¶</a></h2>
<p>Stem uses <a class="reference external" href="http://semver.org/">semantic versioning</a>, which means that
<strong>versions consist of three numbers</strong> (such as ‘<strong>1.2.4</strong>‘). These are used to
convey the kind of backward compatibility a release has...</p>
<blockquote>
<div><ul class="simple">
<li>The first value is the <strong>major version</strong>. This changes infrequently, and
indicates that backward incompatible changes have been made (such as the
removal of deprecated functions).</li>
<li>The second value is the <strong>minor version</strong>. This is the most common kind of
release, and denotes that the improvements are backward compatible.</li>
<li>The third value is the <strong>patch version</strong>. When a stem release has a major
issue another release is made which fixes just that problem. These do not
contain substantial improvements or new features. This value is sometimes
left off to indicate all releases with a given major/minor version.</li>
</ul>
</div></blockquote>
</div>
<div class="section" id="unreleased">
<span id="id2"></span><h2>Unreleased<a class="headerlink" href="#unreleased" title="Permalink to this headline">¶</a></h2>
<p>The following are only available within stem’s <a class="reference external" href="download.html">git repository</a>.</p>
<blockquote>
<div><ul class="simple">
<li><strong>Controller</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li><a class="reference internal" href="api/control.html#stem.control.Controller.get_network_status" title="stem.control.Controller.get_network_status"><tt class="xref py py-func docutils literal"><span class="pre">get_network_status()</span></tt></a> and <a class="reference internal" href="api/control.html#stem.control.Controller.get_network_statuses" title="stem.control.Controller.get_network_statuses"><tt class="xref py py-func docutils literal"><span class="pre">get_network_statuses()</span></tt></a> now provide v3 rather than v2 directory information (<a class="reference external" href="https://trac.torproject.org/7953">ticket 7953</a>, <a class="reference external" href="https://gitweb.torproject.org/torspec.git/commitdiff/d2b7ebb">spec</a>)</li>
<li><a class="reference internal" href="api/response.html#stem.response.events.AddrMapEvent" title="stem.response.events.AddrMapEvent"><tt class="xref py py-class docutils literal"><span class="pre">AddrMapEvent</span></tt></a> support for the new CACHED argument (<a class="reference external" href="https://trac.torproject.org/8596">ticket 8596</a>, <a class="reference external" href="https://gitweb.torproject.org/torspec.git/commitdiff/25b0d43">spec</a>)</li>
<li><a class="reference internal" href="api/control.html#stem.control.Controller.attach_stream" title="stem.control.Controller.attach_stream"><tt class="xref py py-func docutils literal"><span class="pre">attach_stream()</span></tt></a> could encounter an undocumented 555 response (<a class="reference external" href="https://trac.torproject.org/8701">ticket 8701</a>, <a class="reference external" href="https://gitweb.torproject.org/torspec.git/commitdiff/7286576">spec</a>)</li>
<li><a class="reference internal" href="api/descriptor/server_descriptor.html#stem.descriptor.server_descriptor.RelayDescriptor" title="stem.descriptor.server_descriptor.RelayDescriptor"><tt class="xref py py-class docutils literal"><span class="pre">RelayDescriptor</span></tt></a> digest validation was broken when dealing with non-unicode content with python 3 (<a class="reference external" href="https://trac.torproject.org/8755">ticket 8755</a>)</li>
<li>The <a class="reference internal" href="api/control.html#stem.control.Controller" title="stem.control.Controller"><tt class="xref py py-class docutils literal"><span class="pre">Controller</span></tt></a> use of cached content wasn’t thread safe (<a class="reference external" href="https://trac.torproject.org/8607">ticket 8607</a>)</li>
<li>Added <a class="reference internal" href="api/control.html#stem.control.Controller.get_user" title="stem.control.Controller.get_user"><tt class="xref py py-func docutils literal"><span class="pre">get_user()</span></tt></a> method to the <a class="reference internal" href="api/control.html#stem.control.Controller" title="stem.control.Controller"><tt class="xref py py-class docutils literal"><span class="pre">Controller</span></tt></a></li>
<li>Added <a class="reference internal" href="api/control.html#stem.control.Controller.get_pid" title="stem.control.Controller.get_pid"><tt class="xref py py-func docutils literal"><span class="pre">get_pid()</span></tt></a> method to the <a class="reference internal" href="api/control.html#stem.control.Controller" title="stem.control.Controller"><tt class="xref py py-class docutils literal"><span class="pre">Controller</span></tt></a></li>
<li><a class="reference internal" href="api/response.html#stem.response.events.StreamEvent" title="stem.response.events.StreamEvent"><tt class="xref py py-class docutils literal"><span class="pre">StreamEvent</span></tt></a> didn’t recognize IPv6 addresses (<a class="reference external" href="https://trac.torproject.org/9181">ticket 9181</a>)</li>
<li><a class="reference internal" href="api/control.html#stem.control.Controller.get_conf" title="stem.control.Controller.get_conf"><tt class="xref py py-func docutils literal"><span class="pre">get_conf()</span></tt></a> mistakenly cached hidden service related options (<a class="reference external" href="https://trac.torproject.org/9792">ticket 9792</a>)</li>
</ul>
</div></blockquote>
<ul class="simple">
<li><strong>Descriptors</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li>Added the <a class="reference external" href="api/descriptor/remote.html">stem.descriptor.remote</a> module.</li>
<li>Added support for <a class="reference external" href="api/descriptor/tordnsel.html">TorDNSEL exit lists</a> (feature by arlolra, <a class="reference external" href="https://trac.torproject.org/8255">ticket 8255</a>).</li>
<li>The <a class="reference internal" href="api/descriptor/reader.html#stem.descriptor.reader.DescriptorReader" title="stem.descriptor.reader.DescriptorReader"><tt class="xref py py-class docutils literal"><span class="pre">DescriptorReader</span></tt></a> mishandled relative paths (<a class="reference external" href="https://trac.torproject.org/8815">ticket 8815</a>)</li>
</ul>
</div></blockquote>
<ul class="simple">
<li><strong>Utilities</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li>Connection resolution via the <a class="reference internal" href="api/util/connection.html#stem.util.connection.get_connections" title="stem.util.connection.get_connections"><tt class="xref py py-func docutils literal"><span class="pre">get_connections()</span></tt></a> function (<a class="reference external" href="https://trac.torproject.org/7910">ticket 7910</a>)</li>
<li><a class="reference internal" href="api/util/system.html#stem.util.system.set_process_name" title="stem.util.system.set_process_name"><tt class="xref py py-func docutils literal"><span class="pre">set_process_name()</span></tt></a> inserted spaces between characters (<a class="reference external" href="https://trac.torproject.org/8631">ticket 8631</a>)</li>
<li><a class="reference internal" href="api/util/system.html#stem.util.system.get_pid_by_name" title="stem.util.system.get_pid_by_name"><tt class="xref py py-func docutils literal"><span class="pre">get_pid_by_name()</span></tt></a> can now pull for all processes with a given name</li>
<li><a class="reference internal" href="api/util/system.html#stem.util.system.call" title="stem.util.system.call"><tt class="xref py py-func docutils literal"><span class="pre">call()</span></tt></a> ignored the subprocess’ exit status</li>
<li>Added <a class="reference internal" href="api/util/system.html#stem.util.system.get_name_by_pid" title="stem.util.system.get_name_by_pid"><tt class="xref py py-func docutils literal"><span class="pre">stem.util.system.get_name_by_pid()</span></tt></a></li>
<li>Added <a class="reference internal" href="api/util/system.html#stem.util.system.get_user" title="stem.util.system.get_user"><tt class="xref py py-func docutils literal"><span class="pre">stem.util.system.get_user()</span></tt></a></li>
<li>Added <a class="reference internal" href="api/util/system.html#stem.util.system.get_start_time" title="stem.util.system.get_start_time"><tt class="xref py py-func docutils literal"><span class="pre">stem.util.system.get_start_time()</span></tt></a></li>
<li>Added <a class="reference internal" href="api/util/system.html#stem.util.system.get_bsd_jail_path" title="stem.util.system.get_bsd_jail_path"><tt class="xref py py-func docutils literal"><span class="pre">stem.util.system.get_bsd_jail_path()</span></tt></a></li>
<li>Added <a class="reference internal" href="api/util/connection.html#stem.util.connection.is_private_address" title="stem.util.connection.is_private_address"><tt class="xref py py-func docutils literal"><span class="pre">stem.util.connection.is_private_address()</span></tt></a></li>
</ul>
</div></blockquote>
<ul class="simple">
<li><strong>Website</strong></li>
</ul>
<blockquote>
<div><ul class="simple">
<li>Overhaul of stem’s <a class="reference external" href="download.html">download page</a>. This included several
improvements, most notably the addition of PyPI, Ubuntu, Fedora, Slackware,
and FreeBSD.</li>
<li>Replaced default sphinx header with a navbar menu.</li>
<li>Added this change log.</li>
<li>Added the <a class="reference external" href="faq.html">FAQ page</a>.</li>
<li>Settled on a <a class="reference external" href="http://www.wpclipart.com/plants/assorted/P/plant_stem.png.html">logo</a> for
stem.</li>
<li>Expanded the <a class="reference external" href="tutorials/to_russia_with_love.html">client usage tutorial</a>
to cover SocksiPy and include an example for polling Twitter.</li>
<li>Subtler buttons for the frontpage (<a class="reference external" href="https://www.atagar.com/transfer/stem_frontpage/before.png">before</a> and <a class="reference external" href="https://www.atagar.com/transfer/stem_frontpage/after.png">after</a>).</li>
</ul>
</div></blockquote>
</div></blockquote>
</div>
<div class="section" id="version-1-0">
<span id="id3"></span><h2>Version 1.0<a class="headerlink" href="#version-1-0" title="Permalink to this headline">¶</a></h2>
<p>This was the <a class="reference external" href="https://blog.torproject.org/blog/stem-release-10">initial release of stem</a>, made on <strong>March 26th,
2013</strong>.</p>
<blockquote>
<div><ul class="simple">
<li><strong>Version 1.0.1</strong> (March 27th, 2013) - fixed an issue where installing with
python 3.x (python3 setup.py install) resulted in a stacktrace</li>
</ul>
</div></blockquote>
</div>
</div>
</div>
<div class="bottomnav">
</div>
<div class="footer">
</div>
</body>
</html>
