Merge pull request #45 from upstox/feature/reorganizing-as-upstox-client

feat: re-org to upstox_client

Author: Rahulzz

.gitignore

@@ -66,5 +66,5 @@ target/
 #Ignore swagger generated files
 .swagger-codegen/
 .vscode/
-swagger-codegen-ignore
+.swagger-codegen-ignore
 git_push.sh

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright 2023 Upstox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -26,13 +26,13 @@ Python 2.7 and 3.4+
 If the python package is hosted on Github, you can install directly from Github
 
 ```sh
-pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+pip install upstox-python
 ```
-(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+(you may need to run `pip` with root permission: `sudo pip install upstox-python`)
 
 Then import the package:
 ```python
-import swagger_client 
+import upstox_client 
 ```
 
 ### Setuptools
@@ -46,13 +46,7 @@ python setup.py install --user
 
 Then import the package:
 ```python
-import swagger_client
-```
-
-### Test utility
-Test utility file can be found at
-``` 
-./test/sanity_test.py
+import upstox_client
 ```
 
 ## Getting Started
@@ -62,16 +56,16 @@ Please follow the [installation procedure](#installation--usage) and then run th
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: OAUTH2
-configuration = swagger_client.Configuration()
+configuration = upstox_client.Configuration()
 configuration.access_token = 'YOUR_ACCESS_TOKEN'
 
 # create an instance of the API class
-api_instance = swagger_client.ChargeApi(swagger_client.ApiClient(configuration))
+api_instance = upstox_client.ChargeApi(upstox_client.ApiClient(configuration))
 instrument_token = 'instrument_token_example' # str | Key of the instrument
 quantity = 56 # int | Quantity with which the order is to be placed
 product = 'product_example' # str | Product with which the order is to be placed

docs/ChargeApi.md

@@ -1,4 +1,4 @@
-# swagger_client.ChargeApi
+# upstox_client.ChargeApi
 
 All URIs are relative to *https://api-v2.upstox.com*
 
@@ -17,16 +17,16 @@ Compute Brokerage Charges
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: OAUTH2
-configuration = swagger_client.Configuration()
+configuration = upstox_client.Configuration()
 configuration.access_token = 'YOUR_ACCESS_TOKEN'
 
 # create an instance of the API class
-api_instance = swagger_client.ChargeApi(swagger_client.ApiClient(configuration))
+api_instance = upstox_client.ChargeApi(upstox_client.ApiClient(configuration))
 instrument_token = 'instrument_token_example' # str | Key of the instrument
 quantity = 56 # int | Quantity with which the order is to be placed
 product = 'product_example' # str | Product with which the order is to be placed

docs/HistoryApi.md

@@ -1,4 +1,4 @@
-# swagger_client.HistoryApi
+# upstox_client.HistoryApi
 
 All URIs are relative to *https://api-v2.upstox.com*
 
@@ -19,12 +19,12 @@ Get OHLC values for all instruments across various timeframes. Historical data c
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # create an instance of the API class
-api_instance = swagger_client.HistoryApi()
+api_instance = upstox_client.HistoryApi()
 instrument_key = 'instrument_key_example' # str | 
 interval = 'interval_example' # str | 
 to_date = 'to_date_example' # str | 
@@ -73,12 +73,12 @@ Get OHLC values for all instruments across various timeframes. Historical data c
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # create an instance of the API class
-api_instance = swagger_client.HistoryApi()
+api_instance = upstox_client.HistoryApi()
 instrument_key = 'instrument_key_example' # str | 
 interval = 'interval_example' # str | 
 to_date = 'to_date_example' # str | 
@@ -129,12 +129,12 @@ Get OHLC values for all instruments for the present trading day
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # create an instance of the API class
-api_instance = swagger_client.HistoryApi()
+api_instance = upstox_client.HistoryApi()
 instrument_key = 'instrument_key_example' # str | 
 interval = 'interval_example' # str | 
 api_version = 'api_version_example' # str | API Version Header

docs/LoginApi.md

@@ -1,4 +1,4 @@
-# swagger_client.LoginApi
+# upstox_client.LoginApi
 
 All URIs are relative to *https://api-v2.upstox.com*
 
@@ -19,12 +19,12 @@ This provides details on the login endpoint.
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # create an instance of the API class
-api_instance = swagger_client.LoginApi()
+api_instance = upstox_client.LoginApi()
 client_id = 'client_id_example' # str | 
 redirect_uri = 'redirect_uri_example' # str | 
 api_version = 'api_version_example' # str | API Version Header
@@ -74,16 +74,16 @@ Logout
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: OAUTH2
-configuration = swagger_client.Configuration()
+configuration = upstox_client.Configuration()
 configuration.access_token = 'YOUR_ACCESS_TOKEN'
 
 # create an instance of the API class
-api_instance = swagger_client.LoginApi(swagger_client.ApiClient(configuration))
+api_instance = upstox_client.LoginApi(upstox_client.ApiClient(configuration))
 api_version = 'api_version_example' # str | API Version Header
 
 try:
@@ -111,7 +111,7 @@ Name | Type | Description  | Notes
 ### HTTP request headers
 
  - **Content-Type**: Not defined
- - **Accept**: application/json, */*
+ - **Accept**: */*, application/json
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
@@ -126,12 +126,12 @@ This API provides the functionality to obtain opaque token from authorization_co
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # create an instance of the API class
-api_instance = swagger_client.LoginApi()
+api_instance = upstox_client.LoginApi()
 api_version = 'api_version_example' # str | API Version Header
 code = 'code_example' # str |  (optional)
 client_id = 'client_id_example' # str |  (optional)

docs/MarketQuoteApi.md

@@ -1,4 +1,4 @@
-# swagger_client.MarketQuoteApi
+# upstox_client.MarketQuoteApi
 
 All URIs are relative to *https://api-v2.upstox.com*
 
@@ -19,16 +19,16 @@ This API provides the functionality to retrieve the full market quotes for one o
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: OAUTH2
-configuration = swagger_client.Configuration()
+configuration = upstox_client.Configuration()
 configuration.access_token = 'YOUR_ACCESS_TOKEN'
 
 # create an instance of the API class
-api_instance = swagger_client.MarketQuoteApi(swagger_client.ApiClient(configuration))
+api_instance = upstox_client.MarketQuoteApi(upstox_client.ApiClient(configuration))
 symbol = 'symbol_example' # str | Comma separated list of symbols
 api_version = 'api_version_example' # str | API Version Header
 
@@ -73,16 +73,16 @@ This API provides the functionality to retrieve the OHLC quotes for one or more
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: OAUTH2
-configuration = swagger_client.Configuration()
+configuration = upstox_client.Configuration()
 configuration.access_token = 'YOUR_ACCESS_TOKEN'
 
 # create an instance of the API class
-api_instance = swagger_client.MarketQuoteApi(swagger_client.ApiClient(configuration))
+api_instance = upstox_client.MarketQuoteApi(upstox_client.ApiClient(configuration))
 symbol = 'symbol_example' # str | Comma separated list of symbols
 interval = 'interval_example' # str | Interval to get ohlc data
 api_version = 'api_version_example' # str | API Version Header
@@ -129,16 +129,16 @@ This API provides the functionality to retrieve the LTP quotes for one or more i
 ```python
 from __future__ import print_function
 import time
-import swagger_client
-from swagger_client.rest import ApiException
+import upstox_client
+from upstox_client.rest import ApiException
 from pprint import pprint
 
 # Configure OAuth2 access token for authorization: OAUTH2
-configuration = swagger_client.Configuration()
+configuration = upstox_client.Configuration()
 configuration.access_token = 'YOUR_ACCESS_TOKEN'
 
 # create an instance of the API class
-api_instance = swagger_client.MarketQuoteApi(swagger_client.ApiClient(configuration))
+api_instance = upstox_client.MarketQuoteApi(upstox_client.ApiClient(configuration))
 symbol = 'symbol_example' # str | Comma separated list of symbols
 api_version = 'api_version_example' # str | API Version Header