Merge branch 'main_merge_251218_001' into 'main'

feat: Optimize token storage

See merge request webull/webull-openapi-python-sdk!11

Author: 方佳

samples/__init__.py

@@ -1 +1 @@
-__version__ = '1.0.6'
+__version__ = '1.0.7'

samples/account/__init__.py

@@ -0,0 +1 @@
+# coding=utf-8

samples/account/account_client.py

@@ -24,6 +24,12 @@
 your_app_secret = "<your_app_secret>"
 region_id = "<region_id>" # hk or us
 account_id = "<your_account_id>"
+# The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
+# Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
+# If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
+# token_dir = "<your_token_dir>"
+# api_client.set_token_dir(token_dir)
+
 api_client = ApiClient(your_app_key, your_app_secret, region_id)
 api_client.add_endpoint(region_id, optional_api_endpoint)
 

samples/assets/__init__.py

@@ -0,0 +1 @@
+# coding=utf-8

samples/assets/assets_client.py

@@ -24,6 +24,12 @@
 your_app_secret = "<your_app_secret>"
 region_id = "<region_id>" # hk or us
 account_id = "<your_account_id>"
+# The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
+# Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
+# If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
+# token_dir = "<your_token_dir>"
+# api_client.set_token_dir(token_dir)
+
 api_client = ApiClient(your_app_key, your_app_secret, region_id)
 api_client.add_endpoint(region_id, optional_api_endpoint)
 

samples/data/data_client.py

@@ -24,9 +24,16 @@
 your_app_key = "<your_app_key>"
 your_app_secret = "<your_app_secret>"
 region_id = "<region_id>"
+# The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
+# Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
+# If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
+# token_dir = "<your_token_dir>"
+# api_client.set_token_dir(token_dir)
+
 api_client = ApiClient(your_app_key, your_app_secret, region_id)
 api_client.add_endpoint(region_id, optional_api_endpoint)
 
+
 if __name__ == '__main__':
     data_client = DataClient(api_client)
 

samples/data/data_streaming_client.py

@@ -27,6 +27,11 @@
 optional_api_endpoint = "</optional_quotes_endpoint>"
 optional_quotes_endpoint = "</optional_quotes_endpoint>"
 region_id = '<region_id>'
+# The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
+# Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
+# If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
+# token_dir = "<your_token_dir>"
+# data_streaming_client.set_token_dir(token_dir)
 
 session_id = uuid.uuid4().hex
 data_streaming_client = DataStreamingClient(your_app_key, your_app_secret, region_id, session_id,

samples/data/data_streaming_client_async.py

@@ -27,6 +27,11 @@
 optional_api_endpoint = "</optional_quotes_endpoint>"
 optional_quotes_endpoint = "</optional_quotes_endpoint>"
 region_id = '<region_id>'
+# The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
+# Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
+# If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
+# token_dir = "<your_token_dir>"
+# data_streaming_client.set_token_dir(token_dir)
 
 session_id = uuid.uuid4().hex
 data_streaming_client = DataStreamingClient(your_app_key, your_app_secret, region_id, session_id,

samples/order/__init__.py

@@ -0,0 +1 @@
+# coding=utf-8

samples/order/order_option_client.py

@@ -21,6 +21,12 @@
 your_app_secret = "<your_app_secret>"
 region_id = "<region_id>" # hk or us
 account_id = "<your_account_id>"
+# The token_dir parameter can be used to specify the directory for storing the 2FA token. Both absolute and relative paths are supported and this option has the highest priority.
+# Alternatively, the storage directory can be configured via an environment variable with the key WEBULL_OPENAPI_TOKEN_DIR, which also supports both absolute and relative paths.
+# If neither is specified, the default configuration will be used, and the token will be stored at conf/token.txt under the current working directory.
+# token_dir = "<your_token_dir>"
+# api_client.set_token_dir(token_dir)
+
 api_client = ApiClient(your_app_key, your_app_secret, region_id)
 api_client.add_endpoint(region_id, optional_api_endpoint)