added basic rst doc for s3 plugin. fixme: complete doc and example

Author: savon-noir

docs/index.rst

@@ -36,6 +36,7 @@ The different modules are documented below:
    parser
    objects
    diff
+   plugins_s3
 
 Indices and tables
 ==================

docs/plugins_s3.rst

@@ -0,0 +1,14 @@
+libnmap.plugins.s3.NmapS3Plugin
+===============================
+
+Using libnmap.plugins.s3
+------------------------
+
+This modules enables the user to directly use S3 buckets to store and retrieve NmapReports.
+
+NmapS3Plugin methods
+--------------------
+
+.. automodule:: libnmap.plugins.s3
+.. autoclass:: NmapS3Plugin
+    :members:

libnmap/plugins/s3.py

@@ -13,7 +13,8 @@
 
 class NmapS3Plugin(NmapBackendPlugin):
     """
-        This plugin save the reports on S3 and compatible
+        This plugin save the reports on S3 and compatible.
+
         This is now a beta version who use eucalyptus walrus
     """
     def __init__(self, **kwargs):
@@ -46,11 +47,12 @@ def __init__(self, **kwargs):
     def insert(self, report):
         """
             create a json string from an NmapReport instance
-            and push it to S3 bucket
+            and push it to S3 bucket.
+
             :param NmapReport: obj to insert
             :rtype: string
             :return: str id
-            TODO Add tagging option
+            :todo: Add tagging option
         """
         try:
             oid = ObjectId()
@@ -64,7 +66,9 @@ def insert(self, report):
         return str(oid)
 
     def get(self, str_report_id=None):
-        """ select a NmapReport by Id
+        """
+            select a NmapReport by Id.
+
             :param str: id
             :rtype: NmapReport
             :return: NmapReport object
@@ -84,7 +88,7 @@ def getall(self, dict_filter=None):
         """
             :rtype: List of tuple
             :return: list of key/report
-           TODO : add a filter capability
+            :todo: add a filter capability
         """
         nmapreportList = []
         for key in bucket_lister(self.bucket):
@@ -97,6 +101,7 @@ def getall(self, dict_filter=None):
     def delete(self, report_id=None):
         """
             delete an obj from the backend
+
             :param str: id
             :return: dict document with result or None
         """