Fix import problem (#34)

Fix import problem. Thanks Luck finding out the problem,

Author: Genteki

README.md

@@ -39,23 +39,6 @@ if __name__ == "__main__":
     asyncio.run(main())
 ```
 
-Example of a call animation by emulating pressing HotKeys
-```
-async def main():
-    vts = pyvts.vts(plugin_info=plugin_info)
-    await vts.connect()
-    await vts.request_authenticate_token()  # get token
-    await vts.request_authenticate()  # use token
-    b = await vts.request(vts.vts_request.requestHotKeyList())
-    hotKeyList = [hotKey['name'] for hotKey in b['data']['availableHotkeys']]
-    print(hotKeyList) # ['My Animation 1', 'My Animation 2', 'My Animation 3']
-    await vts.request(vts.vts_request.requestTriggerHotKey(hotKeyList[0])) # send request to play 'My Animation 1'
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-
 ### Demo
 
 Demo [examples/start.py](./examples/start.py) is a good startpoint to make plugin for VTubeStudio. 

docs/toctree2_tutorial.md

@@ -1,4 +1,17 @@
 # Tutorial
 
 ```{include} tutorial1_basicusage.md
-```
+:heading-offset: 1
+```
+
+```{include} tutorial2_triggerhotkey.md
+:heading-offset: 1
+```
+
+<!-- ```{toctree} 
+   :hidden: true
+   :maxdepth: 2
+
+tutorial1_basicusage.md
+tutorial2_triggerhotkey.md
+``` -->

docs/tutorial1_basicusage.md

@@ -1,4 +1,4 @@
-## Basic Usage
+# Basic Usage
 
 First import packages
 

docs/tutorial2_triggerhotkey.md

@@ -0,0 +1,44 @@
+# Trigger Hotkey
+
+First import packages
+
+```
+import asyncio, pyvts
+```
+
+Then specify the plugin information and creat `vts` instance in `main`.
+
+```
+plugin_info = {
+    "plugin_name": "trigger hotkey",
+    "developer": "OverHome",
+    "authentication_token_path": "./pyvts_token.txt"
+}
+
+async def main():
+    myvts = pyvts.vts(plugin_info=plugin_info)
+    await myvts.connect()
+    await myvts.request_authenticate_token()  # get token
+    await myvts.request_authenticate()  # use token
+```
+
+Contd. with ``main()``, request list of hotkey from VtubeStudio
+
+```
+    response_data = await myvts.request(myvts.vts_request.requestHotKeyList())
+    hotkey_list = []
+    for hotkey in response_data['data']['availableHotkeys']:
+        hotkey_list.append(hotkey['name'])
+    print(hotkey_list) # ['My Animation 1', 'My Animation 2', ...]
+```
+
+Contd. with ``main``, send request to triiger hotkey
+
+```
+    send_hotkey_request = myvts.vts_request.requestTriggerHotKey(hotkey_list[0])
+    await myvts.request(send_hotkey_request) # send request to play 'My Animation 1'
+    await myvts.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```

examples/trigger_hotkey.py

@@ -0,0 +1,28 @@
+import asyncio, pyvts
+
+plugin_info = {
+    "plugin_name": "trigger hotkey",
+    "developer": "OverHome",
+    "authentication_token_path": "./pyvts_token.txt",
+}
+
+
+async def main():
+    myvts = pyvts.vts(plugin_info=plugin_info)
+    await myvts.connect()
+    await myvts.request_authenticate_token()  # get token
+    await myvts.request_authenticate()  # use token
+
+    response_data = await myvts.request(myvts.vts_request.requestHotKeyList())
+    hotkey_list = []
+    for hotkey in response_data["data"]["availableHotkeys"]:
+        hotkey_list.append(hotkey["name"])
+    print(hotkey_list)  # ['My Animation 1', 'My Animation 2', ...]
+
+    send_hotkey_request = myvts.vts_request.requestTriggerHotKey(hotkey_list[0])
+    await myvts.request(send_hotkey_request)  # send request to play 'My Animation 1'
+    await myvts.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

pyvts/__init__.py

@@ -4,7 +4,7 @@
 
 """
 
-__version__ = "0.2.3"
+__version__ = "0.3.0"
 __all__ = ["vts", "vts_request", "config", "error"]
 
 from .vts import vts

pyvts/config.py

@@ -5,5 +5,5 @@
     "plugin_name": "pyvts",
     "developer": "genteki",
     "icon": None,
-    "authentication_token_path": "./token.txt",
+    "authentication_token_path": "./pyvts_token.txt",
 }

pyvts/vts_request.py

@@ -164,9 +164,7 @@ def requestTriggerHotKey(self, hotkeyID, itemInstanceID=None) -> dict:
             Organized message sending to ``Vtubestudio API``
         """
         msg_type = "HotkeyTriggerRequest"
-        data = {
-            "hotkeyID": hotkeyID
-        }
+        data = {"hotkeyID": hotkeyID}
         return self.BaseRequest(msg_type, data)
 
     def requestTrackingParameterList(self) -> dict:

setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup, find_packages
 
 DESCRIPTION = "A python library for interacting with the VTube Studio API"
-VERSION = "v0.2.3"
+VERSION = "v0.3.0"
 
 setup(
     name="pyvts",
@@ -23,11 +23,12 @@
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11"
     ],
     author="Genteki Zhang",
     author_email="zhangkaiyuan.null@gmail.com",
     url="https://github.com/Genteki/pyvts",
     license="MIT",
-    packages=find_packages(where="pyvts", exclude=["tests.*", "tests"]),
-    install_requires=["websockets", "aiofile"],
+    packages=find_packages(exclude=["tests.*", "tests"]),
+    install_requires=["websockets", "aiofiles"],
 )