challengeyy / pytorctl Goto Github PK

                         TorCtl Python Bindings


TorCtl is a python Tor controller with extensions to support path
building and various constraints on node and path selection, as well as
statistics gathering.

Apps can hook into the TorCtl package at whatever level they wish.

The lowest level of interaction is to use the TorCtl module
(TorCtl/TorCtl.py). Typically this is done by importing TorCtl.TorCtl
and creating a TorCtl.Connection and extending from TorCtl.EventHandler.
This class receives Tor controller events packaged into python classes
from a TorCtl.Connection.

The next level up is to use the TorCtl.PathSupport module. This is done
by importing TorCtl.PathSupport and instantiating or extending from
PathSupport.PathBuilder, which itself extends from TorCtl.EventHandler.
This class handles circuit construction and stream attachment subject to
policies defined by PathSupport.NodeRestrictor and
PathSupport.PathRestrictor implementations.

If you are interested in gathering statistics, you can instead
instantiate or extend from StatsSupport.StatsHandler, which is
again an event handler with hooks to record statistics on circuit
creation, stream bandwidth, and circuit failure information.

All of these modules are pydoced. For more detailed information than
the above overview, you can do:

# pydoc TorCtl.TorCtl
# pydoc TorCtl.PathSupport
# pydoc TorCtl.StatsSupport

There is a minimalistic example of usage of the basic TorCtl.Connection
and TorCtl.EventHandler in run_example() in TorCtl/TorCtl.py.
Other components also have unit tests at the end of their source files.

For more extensive examples of the PathSupport and StatsSupport
interfaces, see the TorFlow project at git url:

git clone git://git.torproject.org/git/torflow.git