Ticket #8577: Stem FAQ.html

File Stem FAQ.html, 5.5 KB (added by ashishnitinpatil, 6 years ago)

Stem FAQ with a decent HTML layout

Line 
1<div id="maincol">
2    <!-- PUT CONTENT AFTER THIS TAG -->
3    <h1>Stem FAQ</h1>
4    <hr>
5    <ul>
6    <li><a href="#WhatIsStem">What is Stem?</a></li>
7    <li><a href="#Stemisdifferent">How is Tor different from TorCtl?</a></li>
8    <li><a href="#DistributingStem">Licensing?</a></li>
9    <li><a href="#StemSupport">How can I get support?</a></li>
10    <li><a href="#HowInstallStem">How do I install Stem?</a></li>
11    <li><a href="#VersionNumbers">What do the version numbers mean?</a></li>
12        <li><a href="#PythonVersionsSupported">Which Python versions are supported?</a></li>
13        <li><a href="#Dependancies">Does Stem have any dependancies?</a></li>
14        <li><a href="#ModulesOverview">Where can I get detailed documentation
15        for all Stem modules?</a></li>
16        </ul>
17    <hr>
18    <a id="WhatIsStem"></a>
19    <h3><a class="anchor" href="#WhatIsStem">What is Stem?</a></h3>
20    <p>
21    Stem is a python controller library for Tor. Like its predecessor, TorCtl,
22        it uses Tor’s control protocol to help developers program against the Tor
23        process, enabling them to build things similar to <a href="https://www.torproject.org/getinvolved/volunteer.html.en#project-vidalia">
24        Vidalia</a> & <a href="https://www.atagar.com/arm/">Arm</a>.
25    </p>
26    <p>
27    Stem is currently developed & maintained by <a href="https://www.atagar.com/">atagar</a> for the Tor software.
28    </p>
29    <hr>
30    <a id="Stemisdifferent"></a>
31    <h3><a class="anchor" href="#Stemisdifferent">How is Stem different from TorCtl?</a></h3>
32    <p>
33    Stem is a controller library with a similar scope to TorCtl, but with better
34        testing, documentation, and API. The project is not yet feature complete.
35    </p>
36    <hr>
37    <a id="DistributingStem"></a>
38    <h3><a class="anchor" href="#DistributingStem">Licensing?</a></h3>
39    <p>
40    Stem is under the <a href="https://www.gnu.org/copyleft/lesser.html">LGPLv3</a> which is a fine license, but poses a bit of a
41        problem for sharing code with our other projects (which are mostly BSD).
42        To share code without needing to hunt down prior contributors we need an
43        individual to have the copyright for the whole stem codebase. This is
44        Damian at present, but I'll probably give it to Tor if I get nailed by a
45        bus.
46    </p>
47    <hr>
48    <a id="StemSupport"></a>
49    <h3><a class="anchor" href="#StemSupport">How can I get support?</a></h3>
50    <p>There is no official support for Stem. Your best bet is to try the following:</p>
51    <ol>
52        <!--The following links need to be corrected accordingly-->
53    <li>Read through this <a href="../docs/faq.html">FAQ</a>.</li>
54    <li>Read through the <a href="../docs/documentation.html">Documentation</a>.</li>
55    <li>Join our <a href="irc://irc.oftc.net#tor">irc channel</a> and
56    state the issue and wait for help.</li>
57    <li>Contact atagar <a
58    href="http://www.atagar.com/contact/">atagar1@gmail.com</a></li>
59    </ol>
60    <hr>
61    <a id="HowInstallStem"></a>
62    <h3><a class="anchor" href="#HowInstallStem">How do I install Stem?</a></h3>
63    <p>
64    If you have pip installed then getting stem can be as simple as...
65        <pre>% pip install stem</pre>
66        Although, if you want to confgure & install latest Stem, you can download
67        Stem Source code from it's <a href="https://git.torproject.org/stem.git">git repository</a>.
68        <pre>% git clone https://git.torproject.org/stem.git</pre>
69        Then, run setup.py -
70        <pre>% python ./setup.py</pre>
71        Also, <a href="https://stem.torproject.org/download.html">this page</a> can be of help.
72    </p>
73    <hr>
74        <a id="VersionNumbers"></a>
75        <h3><a href="#VersionNumbers">What do the version numbers mean?</a></h3>
76        <p>
77        Stem uses <a href="http://semver.org/">semantic versioning</a>, which means that versions consist of three numbers (such as ‘1.2.4‘). These are used to convey the kind of backward compatibility a release has...
78        <ul>
79        <li>
80        The first value is the major version. This changes infrequently, and indicates that backward incompatible changes have been made (such as the removal of deprecated functions).
81        </li>
82        <li>
83        The second value is the minor version. This is the most common kind of release, and denotes that the improvements are backward compatible.
84        </li>
85        <li>
86        The third value is the patch version. 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.
87        </li>
88        </ul>
89    </p>
90        <hr>
91        <a id="PythonVersionsSupported"></a>
92        <h3><a href="#PythonVersionsSupported">Which Python versions are supported?</a></h3>
93        <p>
94        Stem supports both Python 27 & Python 3.x by using 2to3. To install the
95        Python 3.x version of Stem,
96        <!--The following commands might be wrong & needs to be corrected-->
97        <pre>% python3 setup.py --python3</pre>
98        For developers, to run tests for Python 3 version,
99        <pre>% python3 run_tests.py --integ --python3</pre>
100    </p>
101        <hr>
102        <a id="Dependancies"></a>
103        <h3><a href="#Dependancies">Does Stem have any dependancies?</a></h3>
104        <p>
105        <!--I do not know of any, please add any if there-->
106    </p>
107        <hr>
108        <a id="ModulesOverview"></a>
109        <h3><a href="#ModulesOverview">Where can I get detailed documentation
110        for all Stem modules?</a></h3>
111        <p>
112        The <a href="https://stem.torproject.org/api.html">API page</a> would be a good place to begin with.
113        <br>
114        A variety of <a href="https://stem.torproject.org/tutorials.html">Tutorials</a> are also available.
115    </p>
116        <hr>
117  </div>
118  <!-- END MAINCOL -->