version to 5.5.0

CHANGELOG.md

@@ -1,8 +1,24 @@
 # Change Log
 
+## [5.5.0] - 2018-07-09
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.4...master
+
+- Added a warning when ordering legacy storage volumes
+- Added documentation link to volume-order
+- Increased slcli output width limit to 999 characters
+- More unit tests
+- Fixed an issue canceling some block storage volumes
+- Fixed `slcli order` to work with network gateways
+- Fixed an issue showing hardware credentials when they do not exist
+- Fixed an issue showing addressSpace when listing virtual servers
+- Updated ordering class to support baremetal servers with multiple GPU
+- Updated prompt-toolkit as a fix for `slcli shell`
+- Fixed `slcli vlan detail` to not fail when objects don't have a hostname
+- Added user management
+
 
 ## [5.4.4] - 2018-04-18
-- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.3...master
+- Changes: https://github.com/softlayer/softlayer-python/compare/v5.4.3...v5.4.4
 
 - fixed hw list not showing transactions
 - Re-factored RestTransport and XMLRPCTransport, logging is now only done in the DebugTransport

README.rst

@@ -72,6 +72,49 @@ Bugs and feature requests about this library should have a `GitHub issue <https:
 
 Issues with the Softlayer API itself should be addressed by opening a ticket.
 
+
+Examples
+--------
+
+A curated list of examples on how to use this library can be found at `softlayer.github.io <https://softlayer.github.io/python/>`_
+
+Debugging
+---------
+To get the exact API call that this library makes, you can do the following.
+
+For the CLI, just use the -vvv option. If you are using the REST endpoint, this will print out a curl command that you can use, if using XML, this will print the minimal python code to make the request without the softlayer library.
+
+.. code-block:: bash
+  $ slcli -vvv vs list
+
+
+If you are using the library directly in python, you can do something like this.
+
+.. code-bock:: python
+  import SoftLayer
+  import logging
+
+  class invoices():
+
+      def __init__(self):
+          self.client = SoftLayer.Client()
+          debugger = SoftLayer.DebugTransport(self.client.transport)
+          self.client.transport = debugger
+
+      def main(self):
+          mask = "mask[id]"
+          account = self.client.call('Account', 'getObject', mask=mask);
+          print("AccountID: %s" % account['id'])
+
+      def debug(self):
+          for call in self.client.transport.get_last_calls():
+              print(self.client.transport.print_reproduceable(call))
+
+  if __name__ == "__main__":
+      main = example()
+      main.main()
+      main.debug()
+
 System Requirements
 -------------------
 * Python 2.7, 3.3, 3.4, 3.5 or 3.6.

SoftLayer/consts.py

@@ -5,7 +5,7 @@
 
     :license: MIT, see LICENSE for more details.
 """
-VERSION = 'v5.4.4'
+VERSION = 'v5.5.0'
 API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/xmlrpc/v3.1/'
 API_PRIVATE_ENDPOINT = 'https://api.service.softlayer.com/xmlrpc/v3.1/'
 API_PUBLIC_ENDPOINT_REST = 'https://api.softlayer.com/rest/v3.1/'

docs/cli.rst

@@ -15,6 +15,7 @@ functionality not fully documented here.
    cli/ipsec
    cli/vs
    cli/ordering
+   cli/users
 
 
 .. _config_setup:

setup.py

@@ -14,7 +14,7 @@
 
 setup(
     name='SoftLayer',
-    version='5.4.4',
+    version='5.5.0',
     description=DESCRIPTION,
     long_description=LONG_DESCRIPTION,
     author='SoftLayer Technologies, Inc.',

snap/snapcraft.yaml

@@ -1,5 +1,5 @@
 name: slcli # check to see if it's available
-version: '5.4.4.1+git' # check versioning
+version: '5.5.0+git' # check versioning
 summary: Python based SoftLayer API Tool. # 79 char long summary
 description: |
     A command-line interface is also included and can be used to manage various SoftLayer products and services.