From 04e422d1ddc237684b4b236aff984d2f76ec2c8c Mon Sep 17 00:00:00 2001 From: Cameron Dale Date: Wed, 5 Mar 2008 15:03:33 -0800 Subject: [PATCH] Document the DHT package. --- apt_dht_Khashmir/__init__.py | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/apt_dht_Khashmir/__init__.py b/apt_dht_Khashmir/__init__.py index e69de29..cd6f7e8 100644 --- a/apt_dht_Khashmir/__init__.py +++ b/apt_dht_Khashmir/__init__.py @@ -0,0 +1,22 @@ + +"""The apt-dht implementation of the Khashmir DHT. + +These modules implement a modified Khashmir, which is a kademlia-like +Distributed Hash Table available at:: + + http://khashmir.sourceforge.net/ + +The protocol for the implementation's communication is described here:: + + http://www.camrdale.org/apt-dht/protocol.html + +To run the DHT you probably want to do something like:: + + from apt_dht_Khashmir import DHT + myDHT = DHT.DHT() + myDHT.loadConfig(config, section) + myDHT.join() + +at which point you should be up and running and connected to others in the DHT. + +""" -- 2.39.5