Browse code

Adding Compass project

Project idea by gsathya to refactor compass.

Damian Johnson authored on 14/11/2012 06:44:16
Showing 1 changed files
... ...
@@ -675,6 +675,11 @@ meetings around the world.</li>
675 675
     aggregates the Tor relays based on various attributes.
676 676
     </p>
677 677
     
678
+    <p>
679
+    <b>Project Ideas:</b><br />
680
+    <i><a href="#compassRefactoring">Compass Refactoring</a></i>
681
+    </p>
682
+    
678 683
     <a id="project-weather"></a>
679 684
     <h3><a href="https://trac.torproject.org/projects/tor/wiki/org/roadmaps/Weather">Weather</a> (<a
680 685
     href="https://gitweb.torproject.org/weather.git">code</a>, <a
... ...
@@ -1145,6 +1150,32 @@ meetings around the world.</li>
1145 1150
     </ol>
1146 1151
     </li>
1147 1152
     
1153
+    <a id="compassRefactoring"></a>
1154
+    <li>
1155
+    <b>Compass Refactoring</b>
1156
+    <br>
1157
+    Priority: <i>Medium</i>
1158
+    <br>
1159
+    Effort Level: <i>Medium</i>
1160
+    <br>
1161
+    Skill Level: <i>Medium</i>
1162
+    <br>
1163
+    Likely Mentors: <i>gsathya, karsten</i>
1164
+    <p>
1165
+    Compass was first designed to be a cli app and then hacked into a web app.
1166
+    The codebase needs to be refactored such that the main processing code is
1167
+    separated from the display functions(probably into separate files) and made
1168
+    modular so that adding more features (<a
1169
+    href="https://trac.torproject.org/6612">#6612</a>) is easy. For example, the
1170
+    main processing logic could be in compass.py, whereas print_groups() and other
1171
+    display related functions could be part of a separate cli.py; web.py would also
1172
+    have to modified to make use of this new modular code. Bonus points for adding
1173
+    features to compass(<a href="https://trac.torproject.org/6619">#6619</a>, <a
1174
+    href="https://trac.torproject.org/6612">#6612</a>, <a
1175
+    href="https://trac.torproject.org/6728">#6728</a>).
1176
+    </p>
1177
+    </li>
1178
+    
1148 1179
     <!--
1149 1180
     <a id="stemPathsupport"></a>
1150 1181
     <li>