commit 62701b3c3673ad474831363827bcb2a22580bef6 Author: Isis Lovecruft <isis@torproject.org> Date: Sun May 10 23:13:42 2015 +0000 Cleanup bridgedb.Stability module docstring and add file header. --- lib/bridgedb/Stability.py | 34 ++++++++++++++++++++++++++-------- 1 file changed, 26 insertions(+), 8 deletions(-) diff --git a/lib/bridgedb/Stability.py b/lib/bridgedb/Stability.py index 981e005..ad6fd0c 100644 --- a/lib/bridgedb/Stability.py +++ b/lib/bridgedb/Stability.py @@ -1,13 +1,30 @@ +# -*- coding: utf-8 ; test-case-name: bridgedb.test.test_Stability -*- +# +# This file is part of BridgeDB, a Tor bridge distribution system. +# +# :authors: please see the AUTHORS file for attributions +# :copyright: (c) 2013-2015, Isis Lovecruft +# (c) 2013-2015, Matthew Finkel +# (c) 2012-2015, Aaron Gibson +# (c) 2007-2015, Nick Mathewson +# (c) 2007-2015, The Tor Project, Inc. +# :license: see LICENSE for licensing information + +"""This module provides functionality for tracking bridge stability metrics. + +Bridge stability metrics are calculated using the model introduced in +`"An Analysis of Tor Bridge Stability"`_ and +`implemented in the Tor Metrics library`_. + +.. An Analysis of Tor Bridge Stability: + https://metrics.torproject.org/papers/bridge-stability-2011-10-31.pdf + Karsten Loesing, An Analysis of Tor Bridge Stability. Technical Report. + The Tor Project, October 2011. + +.. implemented in the Tor Metrics library: + https://gitweb.torproject.org/metrics-tasks/task-4255/SimulateBridgeStabilit... """ -This module provides functionality for tracking bridge stability metrics, using -the model introduced in [1] and implemented in [2]. -[1] Karsten Loesing, An Analysis of Tor Bridge Stability. Technical Report. -The Tor Project, October 2011. -https://metrics.torproject.org/papers/bridge-stability-2011-10-31.pdf - -[2] https://gitweb.torproject.org/metrics-tasks/task-4255/SimulateBridgeStabilit... -""" import logging import bridgedb.Storage @@ -15,6 +32,7 @@ import bridgedb.Storage weighting_factor = float(19)/float(20) discountIntervalMillis = long(60*60*12*1000) + class BridgeHistory(object): """ Record Class that tracks a single Bridge The fields stored are: