Author: atagar Date: 2014-02-03 15:21:51 +0000 (Mon, 03 Feb 2014) New Revision: 26578 Modified: website/trunk/getinvolved/en/volunteer.wml Log: Dropping 'Stem Usability and Porting' We've already migrated Weather or Stem (... or at least have a patch for doing so). I'm not overly enthusiastic about taking on a student for TorBEL unless Sebastian wants to mentor. If he expresses an interest in mentoring then we'll add it back. Modified: website/trunk/getinvolved/en/volunteer.wml =================================================================== --- website/trunk/getinvolved/en/volunteer.wml 2014-02-03 04:54:12 UTC (rev 26577) +++ website/trunk/getinvolved/en/volunteer.wml 2014-02-03 15:21:51 UTC (rev 26578) @@ -630,7 +630,6 @@ <p> <b>Project Ideas:</b><br /> <i><a href="#txtorcon-stemIntegration">Txtorcon/Stem Integration</a></i><br /> - <i><a href="#stemUsability">Stem Usability and Porting</a></i><br /> <i><a href="#stemTestingForTor">Stem Tests for Tor</a></i> </p> @@ -844,11 +843,6 @@ been inactive. </p> - <p> - <b>Project Ideas:</b><br /> - <i><a href="#stemUsability">Stem Usability and Porting (this includes an idea for finishing off TorBEL)</a></i> - </p> - <a id="project-tor2web"></a> <h3><a href="http://wiki.tor2web.org/index.php/Main_Page">Tor2web</a> (<a @@ -1014,49 +1008,6 @@ </p> </li> - <a id="stemUsability"></a> - <li> - <b>Stem Usability and Porting</b> - <br> - Effort Level: <i>Medium</i> - <br> - Skill Level: <i>Medium</i> - <br> - Likely Mentors: <i>Damian (atagar), Sebastian</i> - <p> - <a href="https://stem.torproject.org/">Stem</a> is a - python controller library for tor. Like it's predecessor, <a - href="https://gitweb.torproject.org/pytorctl.git">TorCtl</a>, it uses tor's <a - 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 href="#project-vidalia">Vidalia</a> and - <a href="https://www.atagar.com/arm/">arm</a>. - </p> - - <p> - While TorCtl provided a fine first draft for this sort of functionality, - it has not proved to be extensible nor maintainable. Stem is a rewrite of - TorCtl with a heavy focus on testing, documentation, and providing a - developer friendly API. - </p> - - <p> - Stem has largely met these goals but there's still plenty of low hanging - fruit in terms of usability improvements. Also, we have clients still using - TorCtl that need to be ported over. This project would include several - subtasks. Some ideas for instance are... - </p> - - <ol> - <li>Come up with a better, more developer friendly "Module Overview" for our documentation (<a href="https://stem.torproject.org/api/control.html">example page</a>). For instance, it would be nice to provide interlinking between the overview and the classes/methods that it lists. This will probably involve asking for help from the <a href="http://sphinx-doc.org/">Sphinx user list</a>. (<a href="https://trac.torproject.org/7632">ticket</a>)</li> - <li>After getting some exposure to stem it would be time to give using it a try. Tor has a couple clients (<a href="https://trac.torproject.org/8263">TorBEL</a> and <a href="https://trac.torproject.org/8264">Tor Weather</a>) that are ready to be moved to stem. Hopefully porting these will also provide us with some lessons on how we can further improve stem's API. <b>Note that this would also involve polishing off <a href="#project-torbel">TorBEL</a>, including the <a href="https://trac.torproject.org/projects/tor/query?status=accepted&status=assigned&status=needs_information&status=needs_review&status=needs_revision&status=new&status=reopened&group=component&component=TorDNSEL%2FTorBEL&order=priority">issues that prevent us from deploying it</a></b>. This later portion would be primarily mentored by Sebastian.</li> - <li><b>... other ideas?</b> The above are just some ideas I've come up with to improve usability and likely not enough to fill the summer. Feel free to suggest some of your own! For instance, one option would be to expand <a href="https://stem.torproject.org/tutorials.html">stem's tutorials</a> with more examples, maybe <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-dev/">contacting tor-dev@</a> to brainstorm ideas. This last bit is pretty open so I look forward to seeing what you come up with!</li> - </ol> - - <p> - <b>As part of your application for this project please write a script that does something interesting with stem.</b> Bonus points if this is something that we can <a href="https://stem.torproject.org/tutorials.html">make a tutorial</a> around! - </p> - <a id="stemTestingForTor"></a> <li> <b>Stem Tests for Tor</b>