fixed documentation and travis-ci problems #version=0.1.3

Author: abzcoding

CHANGELOG.md

@@ -1,6 +1,6 @@
 # APTDetector Changelog
 
-Since February 7, 2016 there have been 0 releases and 8 commits for
+Since February 11, 2016 there have been 0 releases and 8 commits for
 
 an average of zero 0-commit release every 0 weeks.
 

aptdetector/network/parser/__init__.py

@@ -1,4 +1,6 @@
-"""couple of functions that was required to parse and reassemble
+"""http_parser implementation
+
+couple of functions that was required to parse and reassemble
 http requests and responses
 """
 from collections import defaultdict
@@ -69,13 +71,14 @@ def __init__(self):
     def send(self, http_type, data):
         """append http request or reponses
 
+        if the connection is not initiated yet then start the connection
+        and if it's still the current connection then append the packet
+
         Args:
             http_type (HttpType): type of packet
             data (str):  data of unparsed packet
         Returns:
             None
-        if the connection is not initiated yet then start the connection
-        and if it's still the current connection then append the packet
         """
         pkt = None
         if not self.inited:

aptdetector/network/parser/httpparser.py

@@ -3,9 +3,6 @@
 parsing a pcap file so that later we would be able to use
 the urls that was found to check for any harmfull activity
 
-PROTIP:
-    not completed yet, under heavy developement
-
 >>> from aptdetector.network.parser.parse_pcap import parse_pcap_file
 >>> parse_pcap_file()
 Traceback (most recent call last):
@@ -70,6 +67,7 @@ def append_packet(self, packet):
         if the packet is after last ack sequence then
         it's a new packet so add it to buffer , and we
         will deal with it later
+
         Args:
             packet (TcpPack): packet that need to be appended
         """
@@ -81,6 +79,7 @@ def retrieve_packet(self, ack_seq):
 
         read all packets till now and reassmble a packet
         based on it's ack sequence number
+
         Args:
             ack_seq (int): ack sequence number
         Returns:
@@ -135,6 +134,7 @@ def on_packet(self, packet):
         """parse a :class:`TcpPack` object.
 
         change attributes(ack, sin, fin , ...) of a :class:`TcpPack` object
+
         Args:
             packet (TcpPack): packet that need to be appended
         Returns:
@@ -188,6 +188,7 @@ def parse_pcap_file(file_path):
     """pcap parser.
 
     parse a pcap file to get a list :class:`TcpPacket` objects
+
     Args:
         file_path (str): address of the Pcap file that is ready to be parsed
     Returns:

aptdetector/network/parser/parse_pcap.py

@@ -1,7 +1,9 @@
-"""``sniffer`` contains base network sniffer implemntation, but if you
+"""``sniffer`` contains base network sniffer implemntation
+
+but if you
 want to use it, Currently there are two implementation to choose from:
-  * :class:`URLSniffer` - Sniff urls that are moving around in network
-  * :class:`FileSniffer` - Sniff files that are in the network
+* :class:`URLSniffer` - Sniff urls that are moving around in network
+* :class:`FileSniffer` - Sniff files that are in the network
 Both classes are :class:`BaseSniffer` subtypes
 """
 # TODO(implement a test scenrario)
@@ -10,8 +12,6 @@
 from aptdetector.utils.exception import FileParsingException
 from aptdetector.utils.typecheck import params, returns
 
-__all__ = ('BaseSniffer')
-
 
 class BaseSniffer(object):
     """The ``BaseSniffer`` is an implementation of a bare minimum network sniffer.

aptdetector/network/sniffer.py

@@ -0,0 +1,26 @@
+aptdetector.network.parser package
+==================================
+
+aptdetector.network.parser.httpparser module
+--------------------------------------------------------------
+
+.. automodule:: aptdetector.network.parser.httpparser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+aptdetector.network.parser.parse_pcap module
+---------------------------------------------------
+
+.. automodule:: aptdetector.network.parser.parse_pcap
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: aptdetector.network.parser
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/aptdetector.network.parser.rst

@@ -0,0 +1,32 @@
+aptdetector.network package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+    aptdetector.network.parser
+
+aptdetector.network.sniffer module
+-------------------------------------------
+
+.. automodule:: aptdetector.network.sniffer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+aptdetector.network.packet module
+-------------------------------------------
+
+.. automodule:: aptdetector.network.packet
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: aptdetector.network
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/aptdetector.network.rst

@@ -0,0 +1,17 @@
+aptdetector package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    aptdetector.network
+
+Module contents
+---------------
+
+.. automodule:: aptdetector
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/aptdetector.rst

@@ -82,7 +82,14 @@ Section listing
 ---------------
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 4
 
    architecture
-   network
+   aptdetector
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`