# DeviceAtlas Cloud API Upgrade # This document is intended for users of API versions 1.4.1 and below. It has two main sections: 1. Why upgrade? 2. Upgrading from 1.4.1 to 2.0.0 ## Why upgrade? ## Version 2.0.0 and higher of the API provides support for Unicode input. In addition, the pip Python package manager now handles the package installation. ## Upgrading to 2.0.0 ## The DeviceAtlas Cloud API version 2.0.0 is shipped with a different interface than previous versions. This shows the steps to upgrade a system which is currently using a DeviceAtlas Cloud API prior to version 2.0.0. 1. Replace the previous DeviceAtlas Cloud API "Client.py" file with installation of the source distribution package: * deviceatlas-cloud-2.0.0.zip This package contains the new namespace "deviceatlas.cloud.device". 2. Install the API using the pip package installer. ```shell $ pip install deviceatlas-cloud-python-2.0.0.0/Api/deviceatlas-cloud-2.0.0.zip ``` 3. References to the API change. The previous import must be replace with the one shown below. ```python # Previously sys.path.append('/path/to/the/Api') from Client import Client # Now from deviceatlas.cloud.device import Client ``` 4. Creating an instance and set the licence key. ```python client = Client() client.LICENCE_KEY = 'ENTER-YOUR-LICENCE-KEY' ``` You can also change the default API behavior: ```python client.USE_FILE_CACHE = False # Check out the documentation for further details. ``` - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - _ Copyright (c) DeviceAtlas Limited 2021. All Rights Reserved. _ https://deviceatlas.com <!-- HTML+JS for document formatting when opened in browser --> <div class="btn-group" id="main-menu" style="float:right"><a class="btn dropdown-toggle" data-toggle="dropdown" href="#">Menu<span class="caret"></span></a><ul class="dropdown-menu"><li><a href="README.html">Main</a></li><li><a href="README.CloudApi.html">Cloud Client API</a></li><li class="disabled"><a href="README.Upgrade.html">Cloud API Upgrade</a></li><li><a href="./ApiDocs/index.html">Cloud Client API docs</a></li><li class="divider"></li><li><a href="README.ClientSide.html">Client-side Component</a></li></ul></div>