                    Kamaelia.Protocol.Torrent

          Components for downloading and distributing
          files using the BitTorrent peer-to-peer
          protocol.


Note: This software and information is intended to faciliate legal
file distribution. Do not use them for any unlawful activities.
The software project and the author of these components are not
affiliated in any way with the creator(s) of BitTorrent.

Prerequisites
=============
In order to function, Kamaelia's BitTorrent components require the
Mainline (official) BitTorrent client to be installed.

Download source: http://download.bittorrent.com/dl/?M=D

The latest version of the Mainline client that has been tested with
Kamaelia is 4.20.8. This is the minimum version that you should use.

This code has only been successfully tested with version 4.20.8. Some people have
reported problems with more recent versions (regarding a missing or
misplaced language translations file). Try reverting to version 4.20.8 if you
encounter difficulties.

The source (.tar.gz) version is highly recommended as it ensures
Python installs the BitTorrent library to the right place.

Note: On windows, compilation from source requires:
* ctypes - http://sourceforge.net/project/showfiles.php?group_id=71702
* pywin32 - http://sourceforge.net/project/showfiles.php?group_id=78018

Examples
========
TorrentGUI - a minimal Tkinter GUI for BitTorrent
P2PStreamSeed - streaming over BitTorrent, source/uploader/seed
P2PStreamPeer - streaming over BitTorrent, sink/downloader/peer
TorrentSeeder - a console .torrent maker and file seeder

Components
==========
* TorrentClient  - an interface to the Mainline BitTorrent client
* TorrentPatron  - an analogue of TorrentClient that supports several
                  concurrent instances
* TorrentMaker   - a .torrent (BitTorrent metadata) file creator
* TorrentService - a component that shares a single
                   TorrentClient between many TorrentPatrons
* TorrentTracker - a BitTorrent tracker component


August 2006 - Ryan Lothian
Created for Google Summer of Code 2006
