Merge pull request #1360 from delftswa2014/peterb-add-package-informa…

…tion Add package information to __init__.py
Tribler · Apr 13, 2015 · faac4f6 · faac4f6
2 parents 403e2d5 + a7c3b7a
commit faac4f6
Show file tree

Hide file tree

Showing 36 changed files with 128 additions and 0 deletions.
diff --git a/Tribler/Category/__init__.py b/Tribler/Category/__init__.py
@@ -1,2 +1,6 @@
 # Written by Yuan Yuan
 # see LICENSE.txt for license information
+'''
+The category package contains code to categorize torrents and filter the 
+categories according to filter preferences.
+''' 
diff --git a/Tribler/Core/APIImplementation/__init__.py b/Tribler/Core/APIImplementation/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The APIImplementation contains the API for torrents, creating them and maintaining them
+'''
diff --git a/Tribler/Core/CacheDB/__init__.py b/Tribler/Core/CacheDB/__init__.py
@@ -1,2 +1,6 @@
 # Written by Jie Yang
 # see LICENSE.txt for license information
+
+'''
+The CacheDB package contains the cachedDB for Tribler including a notifier and manages different versions 
+'''
diff --git a/Tribler/Core/DecentralizedTracking/__init__.py b/Tribler/Core/DecentralizedTracking/__init__.py
@@ -1,2 +1,5 @@
 # written by Arno Bakker
 # see LICENSE.txt for license information
+'''
+The DecentralizedTracking package contains the pymdht library for profiling networkinformation.
+'''
diff --git a/Tribler/Core/Libtorrent/__init__.py b/Tribler/Core/Libtorrent/__init__.py
@@ -1,5 +1,8 @@
 # Written by Egbert Bouman
 
+'''
+The Libtorrent package contains code to manage the torrent library.
+'''
 
 def checkHandleAndSynchronize(default=None):
     def wrap(f):

diff --git a/Tribler/Core/Modules/__init__.py b/Tribler/Core/Modules/__init__.py
@@ -0,0 +1,3 @@
+'''
+The Modules package contains the tracker manager
+'''
diff --git a/Tribler/Core/RawServer/__init__.py b/Tribler/Core/RawServer/__init__.py
@@ -0,0 +1,3 @@
+'''
+The RawServer package contains the RawServer including a socketHandler and a polling system.
+'''
diff --git a/Tribler/Core/TFTP/__init__.py b/Tribler/Core/TFTP/__init__.py
@@ -0,0 +1,3 @@
+'''
+Contains the the TFTP handler that should be registered at the RawServer to handle TFTP packets
+'''
diff --git a/Tribler/Core/TorrentChecker/__init__.py b/Tribler/Core/TorrentChecker/__init__.py
@@ -0,0 +1,3 @@
+'''
+The TorrentChecker package contains code that checks and schedules torrents.
+'''
diff --git a/Tribler/Core/Upgrade/__init__.py b/Tribler/Core/Upgrade/__init__.py
@@ -0,0 +1,3 @@
+'''
+The upgrade package contains information on how to update Tribler and its database to the new version.
+'''
diff --git a/Tribler/Core/Utilities/__init__.py b/Tribler/Core/Utilities/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Utilities package contains different utility files that are used in the project
+'''
diff --git a/Tribler/Core/Video/__init__.py b/Tribler/Core/Video/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Video package contains the VLCWrapper and code to stream live data in Tribler
+'''
diff --git a/Tribler/Core/__init__.py b/Tribler/Core/__init__.py
@@ -1,5 +1,10 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Core package contains the core functionalities of the Tribler project
+'''
+
 from threading import RLock
 import logging
 

diff --git a/Tribler/Debug/__init__.py b/Tribler/Debug/__init__.py
@@ -1,2 +1,6 @@
 # Written by Boudewijn Schoon
 # see LICENSE.txt for license information
+
+'''
+The Debug package contains code to do debugging in Tribler.
+'''
diff --git a/Tribler/Main/Dialogs/__init__.py b/Tribler/Main/Dialogs/__init__.py
@@ -0,0 +1,3 @@
+'''
+The Dialogs package contains the different dialogs that are shown within Tribler
+'''
diff --git a/Tribler/Main/Utility/Feeds/__init__.py b/Tribler/Main/Utility/Feeds/__init__.py
@@ -1,2 +1,6 @@
 # Written by Niels Zeilemaker
 # see LICENSE.txt for license information
+
+'''
+The Feeds package contains different feeds, rss and directory.
+'''
diff --git a/Tribler/Main/Utility/__init__.py b/Tribler/Main/Utility/__init__.py
@@ -1,2 +1,6 @@
 # Written by ABC authors
 # see LICENSE.txt for license information
+
+'''
+The Utility package contains different utility classes used in the Main package 
+'''
diff --git a/Tribler/Main/__init__.py b/Tribler/Main/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Main package contains code for the GUI of Tribler.
+'''
diff --git a/Tribler/Main/vwxGUI/__init__.py b/Tribler/Main/vwxGUI/__init__.py
@@ -1,6 +1,11 @@
 # Written by Jelle Roozenburg, Maarten ten Brinke, Arno Bakker
 # ReWritten by Niels Zeilemaker
 # see LICENSE.txt for license information
+
+'''
+The vwxGUI package contains code for the regular (non-browser) GUI of Tribler 
+'''
+
 from time import time
 import wx
 import inspect

diff --git a/Tribler/Main/webUI/__init__.py b/Tribler/Main/webUI/__init__.py
@@ -1 +1,5 @@
 # Written by Niels Zeilemaker
+
+'''
+The webUI package contains code to create a user interface that can be viewed using a browser.
+'''
diff --git a/Tribler/Policies/__init__.py b/Tribler/Policies/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Policies package contains different code for rate and seeding policies in Tribler. 
+'''
diff --git a/Tribler/Test/API/__init__.py b/Tribler/Test/API/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The API package contains tests for the API.
+'''
diff --git a/Tribler/Test/__init__.py b/Tribler/Test/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Test package contains unit tests for tribler.
+'''
diff --git a/Tribler/Utilities/__init__.py b/Tribler/Utilities/__init__.py
@@ -1,2 +1,6 @@
 # Written by Arno Bakker
 # see LICENSE.txt for license information
+
+'''
+The Utility package contains different utility classes used in Tribler 
+'''
diff --git a/Tribler/community/__init__.py b/Tribler/community/__init__.py
@@ -0,0 +1,3 @@
+'''
+The community package contains code to create and securely communicate with different communities.
+''' 
diff --git a/Tribler/community/allchannel/__init__.py b/Tribler/community/allchannel/__init__.py
@@ -0,0 +1,3 @@
+'''
+The allchannel package contains the AllChannel community which is used to collect votes for channels, and thereby discover which channels are most popular.
+'''
diff --git a/Tribler/community/bartercast3/__init__.py b/Tribler/community/bartercast3/__init__.py
@@ -0,0 +1,3 @@
+'''
+Tbe bartercast3 package contains the protocol for indirect reciprocity. Provides the incentive to seeding and proxy relay in Tribler.
+'''
diff --git a/Tribler/community/bartercast4/__init__.py b/Tribler/community/bartercast4/__init__.py
@@ -0,0 +1,3 @@
+'''
+The bartercast4 package TTTODO: what does this do?
+'''
diff --git a/Tribler/community/channel/__init__.py b/Tribler/community/channel/__init__.py
@@ -0,0 +1,3 @@
+'''
+The channel package contains a Dispersy community which is used to implement Channels. Channels are lists "favorite" .torrents create by one or more users
+'''
diff --git a/Tribler/community/demers/__init__.py b/Tribler/community/demers/__init__.py
@@ -0,0 +1,3 @@
+'''
+The demers package contains a Dispersy community which can be used to verify the speed of message dissemination
+'''
diff --git a/Tribler/community/metadata/__init__.py b/Tribler/community/metadata/__init__.py
@@ -0,0 +1,3 @@
+'''
+The metadata package contains a Dispersy community which can be used to disseminate metadata of torrents
+'''
diff --git a/Tribler/community/search/__init__.py b/Tribler/community/search/__init__.py
@@ -0,0 +1,3 @@
+'''
+The search package contains a Dispersy community which is used to implement decentralized search in Tribler. It also allows peers to discover new .torrents
+'''
diff --git a/Tribler/community/template/__init__.py b/Tribler/community/template/__init__.py
@@ -0,0 +1,3 @@
+'''
+The template package contains Example files for communities
+'''
diff --git a/Tribler/community/tunnel/Socks5/__init__.py b/Tribler/community/tunnel/Socks5/__init__.py
@@ -0,0 +1,5 @@
+'''
+The Socks5 package contains a basic SOCKS5 server is included which reserves
+circuits for its client connections and tunnels UDP packets over them back and
+forth.
+'''
diff --git a/Tribler/community/tunnel/crypto/__init__.py b/Tribler/community/tunnel/crypto/__init__.py
@@ -0,0 +1,3 @@
+'''
+The crypto package contains TTTODO: What does this do?
+'''
diff --git a/Tribler/community/tunnel/tests/__init__.py b/Tribler/community/tunnel/tests/__init__.py
@@ -0,0 +1,3 @@
+'''
+The test package contains tests for the tunnel
+'''