Tweaks Documentation

* Adds separate page that details the CLI config file format. It wasn't appropriate in-line
  where it was.
* Adds coveralls support
* Adds badges for pypi downloads and pypi version
* Converts README.md to rst format and renames to README.rst. rst is the main format
  supported on PyPi.
* Consolidate unittest2 import logic

Author: sudorandom

.travis.yml

@@ -11,4 +11,3 @@ install:
   - "if [[ $TRAVIS_PYTHON_VERSION = 2.6 ]]; then pip install unittest2 --use-mirrors; fi"
 # command to run tests
 script: python setup.py nosetests
-

MANIFEST.in

@@ -1,2 +1,2 @@
 include LICENSE
-include README.md
+include README.rst

README.md README.rst

@@ -1,30 +1,34 @@
 SoftLayer API Python Client
 ===========================
-SoftLayer API bindings for Python. For use with 
-[SoftLayer's API](http://sldn.softlayer.com/reference/softlayerapi).
 
- * [Module Documentation](http://softlayer.github.com/softlayer-api-python-client)
-  * [API Documentation](http://softlayer.github.com/softlayer-api-python-client/client.html)
-  * [CLI Documentation](http://softlayer.github.com/softlayer-api-python-client/cli.html)
+.. image:: https://badge.fury.io/py/SoftLayer.png
+    :target: http://badge.fury.io/py/SoftLayer
 
-This library provides a simple interface to interact with SoftLayer's XML-RPC
-API and provides support for many of SoftLayer API's features like
-[object masks](http://sldn.softlayer.com/article/Using-Object-Masks-SoftLayerAPI). 
-It also contains a command-line interface that can be used to access various 
-SoftLayer services using the API.
+.. image:: https://pypip.in/d/SoftLayer/badge.png
+        :target: https://crate.io/packages/SoftLayer
 
+SoftLayer API bindings for Python. For use with `SoftLayer's API <http://sldn.softlayer.com/reference/softlayerapi>`_.
+
+This library provides a simple interface to interact with SoftLayer's XML-RPC API and provides support for many of SoftLayer API's features like `object masks <http://sldn.softlayer.com/article/Using-Object-Masks-SoftLayerAPI>`_ and a command-line interface that can be used to access various SoftLayer services using the API.
+
+Documentation
+-------------
+Documentation is available at http://softlayer.github.com/softlayer-api-python-client
+	
 Installation
 ------------
 Install via pip:
-```
-pip install softlayer
-```
+
+.. code-block:: bash
+
+	$ pip install softlayer
+
 
 Or you can install from source. Download source and run:
 
-```
-python setup.py install
-```
+.. code-block:: bash
+	
+	$ python setup.py install
 
 
 The most up to date version of this library can be found on the SoftLayer
@@ -43,5 +47,5 @@ System Requirements
 
 Copyright
 ---------
-This software is Copyright (c) 2013 [SoftLayer Technologies, Inc](http://www.softlayer.com/).
+This software is Copyright (c) 2013 SoftLayer Technologies, Inc.
 See the bundled LICENSE file for more information.

SoftLayer/CLI/core.py

@@ -175,7 +175,7 @@ def main(args=sys.argv[1:], env=Environment()):
             if s:
                 env.out(s)
 
-    except InvalidCommand, e:
+    except InvalidCommand as e:
         env.err(resolver.get_module_help(e.module_name))
         if e.command_name:
             env.err('')

SoftLayer/tests/CLI/core_tests.py

@@ -5,14 +5,11 @@
     :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
     :license: BSD, see LICENSE for more details.
 """
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, patch
 
 import SoftLayer
 import SoftLayer.CLI as cli
+from SoftLayer.tests import unittest
 from SoftLayer.CLI.helpers import CLIAbort
 from SoftLayer.CLI.environment import Environment, InvalidModule
 

SoftLayer/tests/CLI/environment_tests.py

@@ -7,13 +7,10 @@
 """
 import sys
 import os
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import patch, MagicMock
 
 from SoftLayer import API_PUBLIC_ENDPOINT
+from SoftLayer.tests import unittest
 from SoftLayer.CLI.environment import Environment, InvalidCommand
 
 if sys.version_info >= (3,):

SoftLayer/tests/CLI/helper_tests.py

@@ -8,13 +8,10 @@
 import sys
 import os
 import json
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import patch
 
 import SoftLayer.CLI as cli
+from SoftLayer.tests import unittest
 
 if sys.version_info >= (3,):
     raw_input_path = 'builtins.input'

SoftLayer/tests/__init__.py

@@ -0,0 +1,5 @@
+
+try:
+    import unittest2 as unittest
+except ImportError:
+    import unittest  # NOQA

SoftLayer/tests/api_tests.py

@@ -5,15 +5,11 @@
     :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
     :license: BSD, see LICENSE for more details.
 """
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
-
 from mock import patch, call
 
 import SoftLayer
 import SoftLayer.API
+from SoftLayer.tests import unittest
 from SoftLayer.consts import USER_AGENT
 
 

SoftLayer/tests/auth_tests.py

@@ -5,13 +5,9 @@
     :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
     :license: BSD, see LICENSE for more details.
 """
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
-
 from SoftLayer.auth import (
     AuthenticationBase, BasicAuthentication, TokenAuthentication)
+from SoftLayer.tests import unittest
 
 
 class TestAuthenticationBase(unittest.TestCase):

SoftLayer/tests/basic_tests.py

@@ -6,12 +6,8 @@
     :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
     :license: BSD, see LICENSE for more details.
 """
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
-
 import SoftLayer
+from SoftLayer.tests import unittest
 
 
 class TestExceptions(unittest.TestCase):

SoftLayer/tests/functional_tests.py

@@ -5,13 +5,10 @@
     :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
     :license: BSD, see LICENSE for more details.
 """
-import SoftLayer
 import os
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
+import SoftLayer
+from SoftLayer.tests import unittest
 
 
 def get_creds():
@@ -47,7 +44,7 @@ def test_404(self):
             self.assertEqual(e.faultCode, 404)
             self.assertIn('NOT FOUND', e.faultString)
             self.assertIn('NOT FOUND', e.reason)
-        except:
+        else:
             self.fail('No Exception Raised')
 
     def test_no_hostname(self):
@@ -59,7 +56,7 @@ def test_no_hostname(self):
             self.assertEqual(e.faultCode, 0)
             self.assertIn('not known', e.faultString)
             self.assertIn('not known', e.reason)
-        except:
+        else:
             self.fail('No Exception Raised')
 
 
@@ -78,7 +75,7 @@ def test_service_does_not_exist(self):
             self.assertEqual(e.faultCode, '-32601')
             self.assertEqual(e.faultString, 'Service does not exist')
             self.assertEqual(e.reason, 'Service does not exist')
-        except:
+        else:
             self.fail('No Exception Raised')
 
     def test_dns(self):

SoftLayer/tests/managers/cci_tests.py

@@ -6,11 +6,8 @@
     :license: BSD, see LICENSE for more details.
 """
 from SoftLayer import CCIManager
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, ANY, call, patch
 
 

SoftLayer/tests/managers/dns_tests.py

@@ -6,11 +6,8 @@
     :license: BSD, see LICENSE for more details.
 """
 from SoftLayer import DNSManager, DNSZoneNotFound
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, ANY
 
 

SoftLayer/tests/managers/firewall_tests.py

@@ -6,11 +6,8 @@
     :license: BSD, see LICENSE for more details.
 """
 from SoftLayer import FirewallManager
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, ANY
 
 

SoftLayer/tests/managers/hardware_tests.py

@@ -7,11 +7,8 @@
 """
 from SoftLayer import HardwareManager
 from SoftLayer.managers.hardware import get_default_value
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, ANY, call, patch
 
 
@@ -367,4 +364,3 @@ def _setup_package_mocks(self, package_id):
                 'packageId': package_id,
             }],
         }]
-        

SoftLayer/tests/managers/metadata_tests.py

@@ -7,11 +7,8 @@
 """
 from SoftLayer import MetadataManager, SoftLayerError, SoftLayerAPIError
 from SoftLayer.consts import API_PRIVATE_ENDPOINT_REST
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import patch, MagicMock
 
 

SoftLayer/tests/managers/network_tests.py

@@ -6,12 +6,9 @@
     :license: BSD, see LICENSE for more details.
 """
 from SoftLayer import NetworkManager
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
-from mock import MagicMock, ANY, call, patch
+from mock import MagicMock, ANY, call
 
 
 class NetworkTests(unittest.TestCase):

SoftLayer/tests/managers/queue_tests.py

@@ -8,12 +8,9 @@
 from SoftLayer import MessagingManager, Unauthenticated
 import SoftLayer.managers.messaging
 from SoftLayer.consts import USER_AGENT
+from SoftLayer.tests import unittest
 
 import json
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, patch, ANY
 
 QUEUE_1 = {
@@ -45,7 +42,6 @@
 SUBSCRIPTION_LIST = {'item_count': 1, 'items': [SUBSCRIPTION_1]}
 
 
-
 def mocked_auth_call(self):
     self.auth_token = 'NEW_AUTH_TOKEN'
 
@@ -117,7 +113,6 @@ def test_call_unauthed(self):
         self.assertEqual(request.headers, {'X-Auth-Token': 'NEW_AUTH_TOKEN'})
 
 
-
 class MessagingManagerTests(unittest.TestCase):
 
     def setUp(self):
@@ -224,7 +219,7 @@ def test_authenticate(self, auth):
     @patch('SoftLayer.managers.messaging.MessagingConnection._make_request')
     def test_stats(self, make_request):
         content = {
-            'notifications': [{'key': [2012, 7, 27, 14, 31], 'value': 2}], 
+            'notifications': [{'key': [2012, 7, 27, 14, 31], 'value': 2}],
             'requests': [{'key': [2012, 7, 27, 14, 31], 'value': 11}]}
         make_request().content = json.dumps(content)
         result = self.conn.stats()

SoftLayer/tests/managers/ssl_tests.py

@@ -6,11 +6,8 @@
     :license: BSD, see LICENSE for more details.
 """
 from SoftLayer import SSLManager
+from SoftLayer.tests import unittest
 
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import MagicMock, ANY
 
 

SoftLayer/tests/transport_tests.py

@@ -5,14 +5,11 @@
     :copyright: (c) 2013, SoftLayer Technologies, Inc. All rights reserved.
     :license: BSD, see LICENSE for more details.
 """
-try:
-    import unittest2 as unittest
-except ImportError:
-    import unittest  # NOQA
 from mock import patch, MagicMock
 
 from SoftLayer import SoftLayerAPIError, TransportError
 from SoftLayer.transport import make_rest_api_call, make_xml_rpc_api_call
+from SoftLayer.tests import unittest
 from requests import HTTPError, RequestException