[tor-commits] r25886: {website} Adding Compass project Project idea by gsathya to refactor c (website/trunk/getinvolved/en)

[Damian Johnson]

Author: atagar
Date: 2012-11-14 05:44:16 +0000 (Wed, 14 Nov 2012)
New Revision: 25886

Modified:
   website/trunk/getinvolved/en/volunteer.wml
Log:
Adding Compass project

Project idea by gsathya to refactor compass.



Modified: website/trunk/getinvolved/en/volunteer.wml
===================================================================
--- website/trunk/getinvolved/en/volunteer.wml	2012-11-13 19:30:28 UTC (rev 25885)
+++ website/trunk/getinvolved/en/volunteer.wml	2012-11-14 05:44:16 UTC (rev 25886)
@@ -675,6 +675,11 @@
     aggregates the Tor relays based on various attributes.
     </p>
     
+    <p>
+    <b>Project Ideas:</b><br />
+    <i><a href="#compassRefactoring">Compass Refactoring</a></i>
+    </p>
+    
     <a id="project-weather"></a>
     <h3><a href="https://trac.torproject.org/projects/tor/wiki/org/roadmaps/Weather">Weather</a> (<a
     href="https://gitweb.torproject.org/weather.git">code</a>, <a
@@ -1145,6 +1150,32 @@
     </ol>
     </li>
     
+    <a id="compassRefactoring"></a>
+    <li>
+    <b>Compass Refactoring</b>
+    <br>
+    Priority: <i>Medium</i>
+    <br>
+    Effort Level: <i>Medium</i>
+    <br>
+    Skill Level: <i>Medium</i>
+    <br>
+    Likely Mentors: <i>gsathya, karsten</i>
+    <p>
+    Compass was first designed to be a cli app and then hacked into a web app.
+    The codebase needs to be refactored such that the main processing code is
+    separated from the display functions(probably into separate files) and made
+    modular so that adding more features (<a
+    href="https://trac.torproject.org/6612">#6612</a>) is easy. For example, the
+    main processing logic could be in compass.py, whereas print_groups() and other
+    display related functions could be part of a separate cli.py; web.py would also
+    have to modified to make use of this new modular code. Bonus points for adding
+    features to compass(<a href="https://trac.torproject.org/6619">#6619</a>, <a
+    href="https://trac.torproject.org/6612">#6612</a>, <a
+    href="https://trac.torproject.org/6728">#6728</a>).
+    </p>
+    </li>
+    
     <!--
     <a id="stemPathsupport"></a>
     <li>