Raw packet documentation

Author: AlexisTM

rawsocketpy/__init__.py

@@ -1,4 +1,8 @@
-# Package init
+"""A Raw socket implementation allowing any ethernet type to be used/sniffed.
+
+.. moduleauthor:: Alexis Paques <alexis.paques@gmail.com>
+
+"""
 from __future__ import print_function
 try:
     from gevent import monkey; monkey.patch_all()

rawsocketpy/main.py

@@ -2,7 +2,18 @@
 from .util import get_hw, to_str, protocol_to_ethertype, to_bytes
 
 class RawPacket():
+    """RawPacket is the resulting data container. 
+
+    It reads raw data and stores the MAC source, MAC destination, the Ethernet type and the data payload.
+
+    RawPacket.success is true if the packet is successfuly read.
+    """
     def __init__(self, data):
+        """A really simple class.
+
+        Args:
+           foo (data): raw ethernet frame coming from the socket library, either **bytes in Python3** or **str in Python2**
+        """
         self.dest = ""
         self.src = ""
         self.type = ""