Merge pull request #45 from thoughtspot/2.0.1

2.0.1

Author: bryanthowell-ts

README.md

@@ -1,14 +1,12 @@
-*A simple and pythonic Python implementation of ThoughtSpot's REST APIs (both V1 and V2).*
-# LAST RELEASE NOTICE
-The 1.8.8 release will be the last under the `thoughtspot_rest_api_v1 / thoughtspot-rest-api-v1` package name. 
+*A simple and pythonic Python implementation of ThoughtSpot's REST APIs (both V1 and V2.0).*
+# PACKAGE RENAME NOTICE
+The 2.N.N releases of `thoughtspot_rest_api` are a renamed continuation of the older `thoughtspot_rest_api_v1 / thoughtspot-rest-api-v1` packages. 
 
-The package will transition to just `thoughtspot_rest_api / thoughtspot-rest-api` to reflect that V2.0 API is the primary API for ThoughtSpot. All code will remain the same other than the package name changing.
-
-The repository itself will switch to a public / private mirror system at this time as well, which will break existing watching / forks.
+If you are using the `thoughtspot_rest_api_v1` package, please install `thoughtspot_rest_api` and update your import statements and everything should work. All new releases will be under this package name.
 
 # README
 
-`thoughtspot_rest_api_v1` library implements the ThoughtSpot public REST APIs as directly as possible. It is not a "full SDK" with representation of each request and response type, but rather uses Python's Lists and Dicts for input and output.
+`thoughtspot_rest_api` library implements the ThoughtSpot public REST APIs as directly as possible. It is not a "full SDK" with representation of each request and response type, but rather uses Python's Lists and Dicts for input and output.
 
 When using ThoughtSpot Cloud, always chose the V2.0 REST API via the `TSRestApiV2` class.
 
@@ -28,9 +26,9 @@ Method and argument names closely match to the documented API endpoints, with a
 ---
 
 ## Learning from the source code for V1
-At this point, if you have a need to use the V1 REST API, please use the TSRestApiV1 class. If you have some need for using the V1 REST API outside of Pyython, the library can be used a reference for how a V1 REST API endpoint is called correctly, look at the `/src/thoughtspot_rest_api_v1/tsrestapiv1.py` file. It contains the definition of all the ENUMs and the `TSRestApiV1` class. 
+At this point, if you have a need to use the V1 REST API, please use the TSRestApiV1 class. If you have some need for using the V1 REST API outside of Pyython, the library can be used a reference for how a V1 REST API endpoint is called correctly, look at the `/src/thoughtspot_rest_api/tsrestapiv1.py` file. It contains the definition of all the ENUMs and the `TSRestApiV1` class. 
 
-Similarly, the `TSRestApiV2` class is defined in the `/src/thoughtspot_rest_api_v1/tsrestapiv2.py` file.
+Similarly, the `TSRestApiV2` class is defined in the `/src/thoughtspot_rest_api/tsrestapiv2.py` file.
 
 The `TSRestApiV1` class uses the *requests* library to create an internal requests.Session object when the REST API sign-in command is run. This fulfils the ThoughtSpot REST API V1 requirement for session cookie details to be passed in every request.
 
@@ -42,29 +40,29 @@ The library is designed to work with the latest version of ThoughtSpot Cloud. It
 
 ## Getting Started
 
-To install thoughtspot_rest_api_v1, simply run this simple command in your terminal of choice:
+To install thoughtspot_rest_api, simply run this simple command in your terminal of choice:
 
 ```
-$ python3 -m pip install thoughtspot_rest_api_v1
+$ python3 -m pip install thoughtspot_rest_api
 ```
 
 ### Getting the source code
 
 ```
-$ git clone https://github.com/thoughtspot/thoughtspot_rest_api_v1_python.git
+$ git clone https://github.com/thoughtspot/thoughtspot_rest_api_python.git
 ```
 
 Once you have a copy of the source, you can embed it in your own Python package, or install it into your site-packages easily:
 
 ```
-$ cd thoughtspot_rest_api_v1_python
+$ cd thoughtspot_rest_api_python
 $ python3 -m pip install --upgrade
 ```
 
 ---
 
 ## Importing the library
-    from thoughtspot_rest_api_v1 import *
+    from thoughtspot_rest_api import *
 
 This will bring the `TSRestApiV1` and `TSRestApiV2` classes, as well as the following enumerations:  `TSTypes`, `MetadataNames`, `MetadataSorts`, `MetadataSubtypes`, `MetadataCategories`, `ShareModes`, `Privileges`.
 
@@ -94,7 +92,7 @@ REST API V2 allows for Bearer Token authentication, which is the preferred metho
 Next request a Full Access token using `auth_token_full()`. Get the `token` value from the response, then set the `bearer_token` property of the TSRestApiV2 object with the token. The object will keep the bearer token and use it in the headers of any subsequent call.
 
 
-    from thoughtspot_rest_api_v1 import *
+    from thoughtspot_rest_api import *
 
     username = os.getenv('username')  # or type in yourself
     password = os.getenv('password')  # or type in yourself
@@ -110,7 +108,7 @@ Next request a Full Access token using `auth_token_full()`. Get the `token` valu
 
 If you have requested an auth token from the REST API Playground, you can simply set the `bearer_token` property directly
 
-    from thoughtspot_rest_api_v1 import *
+    from thoughtspot_rest_api import *
 
     full_auth_token = '{token_from_playground}'
 

examples/audit_object_access.py

@@ -3,7 +3,7 @@
 import requests.exceptions
 import csv
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 # You are probably better of looking at https://github.com/thoughtspot/cs_tools for more complete versions of this
 # functionality, but this shows how to use the REST APIs directly to put together various information in ways

examples/create_or_update_connection.py

@@ -2,7 +2,7 @@
 import requests.exceptions
 import json
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 #
 # Short script to show how to use the connection_create and connection_update commands

examples/custom_actions.py

@@ -2,7 +2,7 @@
 import json
 import requests
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 # Script to show using the /admin/ endpoints around Custom Actions
 # Specific use-case shown is making an Action available on Context Menu of every viz on a Liveboard

examples/data_exports.py

@@ -1,7 +1,7 @@
 import os
 import json
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 
 username = os.getenv('username')  # or type in yourself

examples/delete_object.py

@@ -1,7 +1,7 @@
 import os
 import requests.exceptions
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 # This script uses the internal metadata/delete API endpoint, which will be unnecessary once the V2 API introduces
 # a public form of delete. But it may be of use now

examples/import_tables_rest_api.py

@@ -2,7 +2,7 @@
 import requests.exceptions
 import json
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 
 #

examples/liveboard_pdf_export.py

@@ -1,7 +1,7 @@
 import os
 import requests.exceptions
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 
 username = os.getenv('username')  # or type in yourself

examples/objects_info_metadata.py

@@ -1,7 +1,7 @@
 import os
 import requests.exceptions
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 
 # Details about objects within ThoughtSpot all are accessed through 'metadata/' endpoints, which can be used

examples/share_objects_access_control.py

@@ -1,7 +1,7 @@
 import os
 import json
 
-from thoughtspot_rest_api_v1 import *
+from thoughtspot_rest_api import *
 
 
 # You are probably better off looking at https://github.com/thoughtspot/cs_tools for more complete versions of this