Merge pull request #14 from krasoffski/docfix

Fix readme and updated email

Author: avarabyeu

.travis.yml

@@ -5,5 +5,9 @@ python:
   - "3.4"
   - "3.5"
   - "3.6"
+install:
+  - pip install pep8
+before_script:
+   pep8 .
 script:
   - python setup.py -q install

README.md

@@ -6,10 +6,10 @@
 Library used only for implementors of custom listeners for ReportPortal
 
 
-## Allready implemented listeners:
+## Already implemented listeners:
 
-- [Robot Framework](https://github.com/reportportal/agent-Python-RobotFramework)
 - [PyTest Framework](https://github.com/reportportal/agent-python-pytest)
+- [Robot Framework](https://github.com/reportportal/agent-Python-RobotFramework)
 
 
 ## Installation
@@ -57,9 +57,9 @@ def my_error_handler(exc_info):
     This callback function will be called by async service client when error occurs.
     Return True if error is not critical and you want to continue work.
     :param exc_info: result of sys.exc_info() -> (type, value, traceback)
-    :return: 
+    :return:
     """
-    print("Error occured: {}".format(exc_info[1]))
+    print("Error occurred: {}".format(exc_info[1]))
     traceback.print_exception(*exc_info)
 
 
@@ -76,7 +76,7 @@ test = service.start_test_item(name="Test Case",
                                description="First Test Case",
                                tags=["Image", "Smoke"],
                                start_time=timestamp(),
-                               item_type="TEST")
+                               item_type="STEP")
 
 # Create text log message with INFO level.
 service.log(time=timestamp(),
@@ -89,7 +89,7 @@ service.log(time=timestamp(),
             level="WARN",
             attachment={
                 "name": "free_memory.txt",
-                "data": subprocess.check_output("ps".split()),
+                "data": subprocess.check_output("free -h".split()),
                 "mime": "text/plain"
             })
 
@@ -117,7 +117,7 @@ service.finish_test_item(end_time=timestamp(), status="PASSED")
 service.finish_launch(end_time=timestamp())
 
 # Due to async nature of the service we need to call terminate() method which
-# ensures all pending requests to server are proccessed.
+# ensures all pending requests to server are processed.
 # Failure to call terminate() may result in lost data.
 service.terminate()
 ```

reportportal_client/service_async.py

@@ -97,23 +97,23 @@ def stop(self, nowait=False):
         This asks the thread to terminate, and then waits for it to do so.
         Note that if you don't call this before your application exits, there
         may be some records still left on the queue, which won't be processed.
-        If nowait is False then thread will handle remaining items in queue and 
+        If nowait is False then thread will handle remaining items in queue and
         stop.
-        If nowait is True then thread will be stopped even if the queue still 
+        If nowait is True then thread will be stopped even if the queue still
         contains items.
         """
         self._stop.set()
         if nowait:
             self._stop_nowait.set()
         self.queue.put_nowait(self._sentinel_item)
-        if (self._thread.isAlive()
-                and self._thread is not threading.currentThread()):
+        if (self._thread.isAlive() and
+                self._thread is not threading.currentThread()):
             self._thread.join()
         self._thread = None
 
 
 class ReportPortalServiceAsync(object):
-    """Wrapper around service class to transparently provide async operations 
+    """Wrapper around service class to transparently provide async operations
     to agents."""
 
     BATCH_SIZE = 20
@@ -127,12 +127,13 @@ def __init__(self, endpoint, project, token, api_base="api/v1",
             project: project name to use for launch names.
             token: authorization token.
             api_base: defaults to api/v1, can be changed to other version.
-            error_handler: function to be called to handle errors occured during
-            items processing (in thread)
+            error_handler: function to be called to handle errors occurred
+                during items processing (in thread)
         """
         super(ReportPortalServiceAsync, self).__init__()
         self.error_handler = error_handler
-        self.rp_client = ReportPortalService(endpoint, project, token, api_base)
+        self.rp_client = ReportPortalService(
+            endpoint, project, token, api_base)
         self.log_batch = []
         self.supported_methods = ["start_launch", "finish_launch",
                                   "start_test_item", "finish_test_item", "log"]
@@ -157,7 +158,7 @@ def terminate(self, nowait=False):
         try:
             if not nowait:
                 self._post_log_batch()
-        except Exception as err:
+        except Exception:
             if self.error_handler:
                 self.error_handler(sys.exc_info())
             else:
@@ -201,7 +202,7 @@ def process_item(self, item):
             else:
                 self._post_log_batch()
                 getattr(self.rp_client, method)(**kwargs)
-        except Exception as err:
+        except Exception:
             if self.error_handler:
                 if not self.error_handler(sys.exc_info()):
                     self.terminate(nowait=True)

setup.py

@@ -6,10 +6,11 @@
     version='2.6.0',
     description='Python client for Report Portal',
     author='Artsiom Tkachou',
-    author_email='artsiom_tkachou@epam.com',
+    author_email='SupportEPMC-TSTReportPortal@epam.com',
     url='https://github.com/reportportal/client-Python',
     download_url='https://github.com/reportportal/client-Python/tarball/2.6.0',
+    license='GNU General Public License v3',
     keywords=['testing', 'reporting', 'reportportal'],
     classifiers=[],
-    install_requires=["requests>=2.4.2"],
+    install_requires=['requests>=2.4.2'],
 )