README

   1 tor-relay-stats.py
   2 ==================
   3
   4 This script extract some statistics about relays using aggregate data
   5 based on the current consensus.
   6
   7 Usage
   8 -----
   9
  10 Run the script with --help to learn about its usage:
  11
  12   ./tor-relays-stats.py -h
  13
  14 Examples:
  15
  16  - To get the top five exit nodes in France:
  17    ./tor-relays-stats.py --top=5 --exits-only --country=fr
  18  - To get weights of the top ten AS of all relays in Germany:
  19    ./tor-relays-stats.py --top=10 --by-as --country=de
  20
  21 Retrieving the data
  22 -------------------
  23
  24 This script expect to have a file called 'details.json' in the
  25 current directory. Run with the --download option or issue the following
  26 command to obtain that file:
  27
  28     curl -o details.json 'https://onionoo.torproject.org/details?type=relay&running=true'
  29
  30 Dependencies
  31 ------------
  32
  33 Written and tested on Python 2.6.6.
  34
  35 Authors
  36 -------
  37
  38  * delber <delber@riseup.net>
  39  * Karsten Loesing <karsten@torproject.org>
  40
  41 Licence
  42 -------
  43
  44 This program is free software. It comes without any warranty, to
  45 the extent permitted by applicable law. You can redistribute it
  46 and/or modify it under the terms of the Do What The Fuck You Want
  47 To Public License, Version 2, as published by Sam Hocevar. See
  48 http://sam.zoy.org/wtfpl/COPYING for more details.