updated readme

Author: tr4n2uil

README.md

@@ -0,0 +1,43 @@
+# browserstack-local-python
+
+## Setup
+
+```
+pip install browserstack-local
+```
+
+## API
+
+### Constructor
+
+* `browserstack.Local()`: creates an instance of Local
+
+### Methods
+
+* `start(**options)`: starts Local instance with options. The options available are detailed below.
+* `stop()`: stops the Local instance
+* `isRunning()`: checks if Local instance is running
+
+### Options
+
+* `key`: BrowserStack Access Key
+* `v`: Provides verbose logging
+* `f`: If you want to test local folder rather internal server, provide path to folder as value of this option
+* `force`: Kill other running Browserstack Local
+* `only`: Restricts Local Testing access to specified local servers and/or folders
+* `forcelocal`: Route all traffic via local machine
+* `onlyAutomate`: Disable Live Testing and Screenshots, just test Automate
+* `proxyHost`: Hostname/IP of proxy, remaining proxy options are ignored if this option is absent
+* `proxyPort`: Port for the proxy, defaults to 3128 when -proxyHost is used
+* `proxyUser`: Username for connecting to proxy (Basic Auth Only)
+* `proxyPass`: Password for USERNAME, will be ignored if USERNAME is empty or not specified
+* `localIdentifier`: If doing simultaneous multiple local testing connections, set this uniquely for different processes
+* `hosts`: List of hosts and ports where Local must be enabled for eg. localhost,3000,1,localhost,3001,0
+* `logfile`: Path to file where Local logs be saved to
+* `binary_path`: Optional path to Local binary
+
+
+## Tests
+
+To run the test suite run, `python -m unittest discover`.
+

browserstack/local.py

@@ -45,11 +45,11 @@ def start(self, **kwargs):
           break
 
     while True:
-      if self.is_running():
+      if self.isRunning():
         break
       time.sleep(1)
 
-  def is_running(self):
+  def isRunning(self):
     if (hasattr(self, 'proc')):
       return True if self.proc.poll() is None else False
     return False
@@ -91,7 +91,7 @@ def stop(self):
     try:
       self.proc.terminate()
       while True:
-        if not self.is_running():
+        if not self.isRunning():
           break
         time.sleep(1)
     except Exception as e:

tests/test_local.py

@@ -48,6 +48,6 @@ def test_invalid_option(self):
     self.assertRaises(BrowserStackLocalError, lambda: self.local.start(random=True))
 
   def test_running(self):
-    self.assertFalse(self.local.is_running())
+    self.assertFalse(self.local.isRunning())
     self.local.start()
-    self.assertTrue(self.local.is_running())
+    self.assertTrue(self.local.isRunning())