txtorcon docs


Contents   ::   Releases  »


txtorcon is a Twisted-based Python asynchronous controller library for Tor, following control-spec. This would be of interest to anyone wishing to write event-based software in Python that talks to a Tor program.

Cut to the chase by perusing the Walkthrough.

The main code is under 2000 lines according to ohcount, or 4500 lines including tests. Some features and motivating examples:

This documentation was generated April 03, 2014.

https://travis-ci.org/meejah/txtorcon.png?branch=master https://coveralls.io/repos/meejah/txtorcon/badge.png https://pypip.in/d/txtorcon/badge.png

Getting txtorcon:

The canonical URI is http://timaq4ygg2iegci7.onion Code available at https://github.com/meejah/txtorcon

If you’re using Debian, txtorcon is now in testing (jessie) and wheezy-backports thanks to Lunar:

echo "deb http://ftp.ca.debian.org/debian/ wheezy-backports main" >> /etc/apt/sources.list
apt-get update
apt-get install python-txtorcon

Installing the wheel files requires a recent pip and setuptools. At least on Debian, it is important to upgrade setuptools before pip. This procedure appears to work fine:

virtualenv foo
. foo/bin/activate
pip install --upgrade setuptools
pip install --upgrade pip
pip install path/to/txtorcon-0.9.0-py27-none-any.whl

Known Users:

  • txtorcon received a brief mention at 29C3 starting at 12:20 (or via youtube).
  • APAF anonymous Python application framework
  • OONI the Open Observatory of Network Interference

Indices and tables

Contents   ::   Releases  »