[metrics-tasks/master] Update README (#6329).

commit 0c7660b62ea92ef8ee4312ba5317dbf21d8a6a5a Author: Karsten Loesing <karsten.loesing@gmx.net> Date: Fri Jul 20 15:57:44 2012 +0200 Update README (#6329). --- task-6329/README | 23 +++++++++-------------- 1 files changed, 9 insertions(+), 14 deletions(-) diff --git a/task-6329/README b/task-6329/README index 0c6c501..bbb36ae 100644 --- a/task-6329/README +++ b/task-6329/README @@ -7,29 +7,23 @@ based on the current consensus. Usage ----- -Usage: tor-relays-stats.py <output> [args ...] +Run the script with --help to learn about its usage: -Where <output> is one of: - - countries [COUNT] [FLAGS] - relative percentage of the consensus in each countries - - as-sets [COUNT] [FLAGS] [COUNTRIES] - relative percentage of the consensus in each AS sets - - relays [COUNT] [FLAGS] [COUNTRIES] [AS_SETS] - list relays ranked by their place in the whole consensus + ./tor-relays-stats.py -h Examples: - To get the top five exit nodes in France: - tor-relays-stats.py top 5 Exit fr + ./tor-relays-stats.py --top=5 --exits-only --country=fr - To get weights of the top ten AS of all relays in Germany: - tor-relays-stats.py as-sets 10 Running de + ./tor-relays-stats.py --top=10 --by-as --country=de Retrieving the data ------------------- This script expect to have a file called 'details.json' in the -current directory. In order to retrieve the needed data, one -can issue the following command: +current directory. Run with the --download option or issue the following +command to obtain that file: curl -o details.json 'https://onionoo.torproject.org/details?type=relay&running=true' @@ -38,10 +32,11 @@ Dependencies Written and tested on Python 2.6.6. -Author ------- +Authors +------- * delber <delber@riseup.net> + * Karsten Loesing <karsten@torproject.org> Licence -------
participants (1)
-
karsten@torproject.org