vrchatapi-async 1.20.8__tar.gz

vrchatapi_async-1.20.8/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Owners of GitHub organisation "vrchatapi" and individual contributors.
+
+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.

vrchatapi_async-1.20.8/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: vrchatapi-async
+Version: 1.20.8
+Summary: VRChat API Library for Python (async version)
+Home-page: https://github.com/hi94740/vrchatapi-python-async
+Author: hi94740
+Author-email: hi94740@qq.com
+License: MIT
+Keywords: vrchat,vrchatapi,vrc
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: aiohttp>=3.13.5
+Requires-Dist: aiohttp-retry>=2.8.3
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+![](https://github.com/vrchatapi/vrchatapi.github.io/blob/main/static/assets/img/lang/lang_python_banner_1500x300.png?raw=true)
+
+# VRChat API Library for Python (async)
+
+A Python client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).
+
+This is an **asynchronous** (asyncio + aiohttp) adaptation of [VRChatAPI-Python](https://github.com/vrchatapi/vrchatapi-python). All API
+methods are coroutines and must be awaited.
+
+## Disclaimer
+
+This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.
+
+> Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:
+> * We do not provide documentation or support for the API.
+> * Do not make queries to the API more than once per 60 seconds.
+> * Abuse of the API may result in account termination.
+> * Access to API endpoints may break at any given time, with no warning.
+
+As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.
+
+## Getting Started
+
+First add the package to to your project:
+```bash
+pip install vrchatapi-async
+```
+
+Below is an example on how to login to the API and fetch your own user information.
+
+```python
+import asyncio
+
+# Step 1. We begin with creating a Configuration, which contains the username and password for authentication.
+import vrchatapi
+from vrchatapi.api import authentication_api
+from vrchatapi.exceptions import UnauthorizedException
+from vrchatapi.models.two_factor_auth_code import TwoFactorAuthCode
+from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode
+
+
+async def main():
+    configuration = vrchatapi.Configuration(
+        username = 'username',
+        password = 'password',
+    )
+
+    # Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
+    # Here we enter a context of the API Client and instantiate the Authentication API which is required for logging in.
+
+    # Enter a context with an instance of the API client
+    async with vrchatapi.ApiClient(configuration) as api_client:
+        # Set our User-Agent as per VRChat Usage Policy
+        api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
+
+        # Instantiate instances of API classes
+        auth_api = authentication_api.AuthenticationApi(api_client)
+
+        try:
+            # Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
+            current_user = await auth_api.get_current_user()
+        except UnauthorizedException as e:
+            if e.status == 200:
+                if "Email 2 Factor Authentication" in e.reason:
+                    # Step 3.5. Calling email verify2fa if the account has 2FA disabled
+                    await auth_api.verify2_fa_email_code(two_factor_email_code=TwoFactorEmailCode(input("Email 2FA Code: ")))
+                elif "2 Factor Authentication" in e.reason:
+                    # Step 3.5. Calling verify2fa if the account has 2FA enabled
+                    await auth_api.verify2_fa(two_factor_auth_code=TwoFactorAuthCode(input("2FA Code: ")))
+                current_user = await auth_api.get_current_user()
+            else:
+                print("Exception when calling API: %s
+", e)
+        except vrchatapi.ApiException as e:
+            print("Exception when calling API: %s
+", e)
+
+        print("Logged in as:", current_user.display_name)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+See [Examples](examples/README.md) for more example usage on getting started.
+
+## Async API notes
+
+Compared to [the synchronous SDK](https://github.com/vrchatapi/vrchatapi-python), this version changes the calling convention:
+
+- Every API method (`foo`, `foo_with_http_info`, `foo_without_preload_content`)
+  is an `async def` coroutine and must be awaited.
+- `ApiClient` is used as an async context manager (`async with ... as api_client`).
+- The `async_req` parameter and the thread-pool based `async_req=True` usage are
+  removed; calls are natively asynchronous.
+- `foo_with_http_info()` returns an `ApiResponse` object (`status_code`,
+  `headers`, `data`, `raw_data`) instead of a `(data, status, headers)` tuple.
+- `foo_without_preload_content()` returns the raw aiohttp response for
+  streaming; the legacy `_preload_content=False` parameter is removed.
+- The session `CookieJar`, the readable 2FA errors
+  (`UnauthorizedException` with status 200), the URL-encoded basic auth, the
+  `~()` safe path-parameter charset and the lowercase boolean query parameters
+  behave exactly like the synchronous SDK.
+
+## Contributing
+
+Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.
+
+## Websocket (Pipeline) API
+
+The SDK also ships a hand-written async client for VRChat's real-time
+WebSocket (Pipeline) API (`wss://pipeline.vrchat.cloud`), which pushes invites,
+friend requests, friend online/offline events, user and group updates to the
+authenticated client. The connection is receive-only; every message's
+double-encoded `content` field is automatically unpacked into a plain dict.
+
+```python
+import asyncio
+
+import vrchatapi
+from vrchatapi.api import authentication_api
+from vrchatapi.websocket import VRChatWebSocket
+
+
+async def main():
+    configuration = vrchatapi.Configuration(username="username", password="password")
+    async with vrchatapi.ApiClient(configuration) as api_client:
+        api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
+        await authentication_api.AuthenticationApi(api_client).get_current_user()
+
+        # Reads the auth cookie + User-Agent from the logged-in client.
+        ws = VRChatWebSocket.from_client(api_client)
+
+        @ws.on("friend-online")
+        async def on_friend_online(event):
+            print("online:", event.content["user"]["displayName"])
+
+        # Or consume the same stream as an async iterator:
+        #   async for event in ws:
+        #       print(event.type, event.content)
+
+        await ws.run()  # blocks; reconnects automatically by default
+```
+
+`VRChatWebSocket` supports callback registration (`ws.on("friend-online", ...)`
+/ `@ws.on(...)`, a catch-all `ws.on_event(...)`), an async iterator over the
+same event stream, error/connect/disconnect/reconnect hooks, automatic
+reconnection with exponential backoff (`auto_reconnect=False` disables it), and
+a configurable application-level heartbeat (default 30s;
+`heartbeat_interval=None` disables it). See
+[examples/examples-source/websocket.py](examples/examples-source/websocket.py)
+and the [Websocket API reference](https://vrchat.community/websocket) for
+details.
+    

vrchatapi_async-1.20.8/README.md

@@ -0,0 +1,151 @@
+![](https://github.com/vrchatapi/vrchatapi.github.io/blob/main/static/assets/img/lang/lang_python_banner_1500x300.png?raw=true)
+
+# VRChat API Library for Python (async)
+
+A Python client to interact with the unofficial VRChat API. Supports all REST calls specified in the [API specification](https://github.com/vrchatapi/specification).
+
+This is an **asynchronous** (asyncio + aiohttp) adaptation of [VRChatAPI-Python](https://github.com/vrchatapi/vrchatapi-python). All API
+methods are coroutines and must be awaited.
+
+## Disclaimer
+
+This is the official response of the VRChat Team (from Tupper more specifically) on the usage of the VRChat API.
+
+> Use of the API using applications other than the approved methods (website, VRChat application) are not officially supported. You may use the API for your own application, but keep these guidelines in mind:
+> * We do not provide documentation or support for the API.
+> * Do not make queries to the API more than once per 60 seconds.
+> * Abuse of the API may result in account termination.
+> * Access to API endpoints may break at any given time, with no warning.
+
+As stated, this documentation was not created with the help of the official VRChat team. Therefore this documentation is not an official documentation of the VRChat API and may not be always up to date with the latest versions. If you find that a page or endpoint is not longer valid please create an issue and tell us so we can fix it.
+
+## Getting Started
+
+First add the package to to your project:
+```bash
+pip install vrchatapi-async
+```
+
+Below is an example on how to login to the API and fetch your own user information.
+
+```python
+import asyncio
+
+# Step 1. We begin with creating a Configuration, which contains the username and password for authentication.
+import vrchatapi
+from vrchatapi.api import authentication_api
+from vrchatapi.exceptions import UnauthorizedException
+from vrchatapi.models.two_factor_auth_code import TwoFactorAuthCode
+from vrchatapi.models.two_factor_email_code import TwoFactorEmailCode
+
+
+async def main():
+    configuration = vrchatapi.Configuration(
+        username = 'username',
+        password = 'password',
+    )
+
+    # Step 2. VRChat consists of several API's (WorldsApi, UsersApi, FilesApi, NotificationsApi, FriendsApi, etc...)
+    # Here we enter a context of the API Client and instantiate the Authentication API which is required for logging in.
+
+    # Enter a context with an instance of the API client
+    async with vrchatapi.ApiClient(configuration) as api_client:
+        # Set our User-Agent as per VRChat Usage Policy
+        api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
+
+        # Instantiate instances of API classes
+        auth_api = authentication_api.AuthenticationApi(api_client)
+
+        try:
+            # Step 3. Calling getCurrentUser on Authentication API logs you in if the user isn't already logged in.
+            current_user = await auth_api.get_current_user()
+        except UnauthorizedException as e:
+            if e.status == 200:
+                if "Email 2 Factor Authentication" in e.reason:
+                    # Step 3.5. Calling email verify2fa if the account has 2FA disabled
+                    await auth_api.verify2_fa_email_code(two_factor_email_code=TwoFactorEmailCode(input("Email 2FA Code: ")))
+                elif "2 Factor Authentication" in e.reason:
+                    # Step 3.5. Calling verify2fa if the account has 2FA enabled
+                    await auth_api.verify2_fa(two_factor_auth_code=TwoFactorAuthCode(input("2FA Code: ")))
+                current_user = await auth_api.get_current_user()
+            else:
+                print("Exception when calling API: %s\n", e)
+        except vrchatapi.ApiException as e:
+            print("Exception when calling API: %s\n", e)
+
+        print("Logged in as:", current_user.display_name)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+See [Examples](examples/README.md) for more example usage on getting started.
+
+## Async API notes
+
+Compared to [the synchronous SDK](https://github.com/vrchatapi/vrchatapi-python), this version changes the calling convention:
+
+- Every API method (`foo`, `foo_with_http_info`, `foo_without_preload_content`)
+  is an `async def` coroutine and must be awaited.
+- `ApiClient` is used as an async context manager (`async with ... as api_client`).
+- The `async_req` parameter and the thread-pool based `async_req=True` usage are
+  removed; calls are natively asynchronous.
+- `foo_with_http_info()` returns an `ApiResponse` object (`status_code`,
+  `headers`, `data`, `raw_data`) instead of a `(data, status, headers)` tuple.
+- `foo_without_preload_content()` returns the raw aiohttp response for
+  streaming; the legacy `_preload_content=False` parameter is removed.
+- The session `CookieJar`, the readable 2FA errors
+  (`UnauthorizedException` with status 200), the URL-encoded basic auth, the
+  `~()` safe path-parameter charset and the lowercase boolean query parameters
+  behave exactly like the synchronous SDK.
+
+## Contributing
+
+Contributions are welcome, but do not add features that should be handled by the OpenAPI specification.
+
+## Websocket (Pipeline) API
+
+The SDK also ships a hand-written async client for VRChat's real-time
+WebSocket (Pipeline) API (`wss://pipeline.vrchat.cloud`), which pushes invites,
+friend requests, friend online/offline events, user and group updates to the
+authenticated client. The connection is receive-only; every message's
+double-encoded `content` field is automatically unpacked into a plain dict.
+
+```python
+import asyncio
+
+import vrchatapi
+from vrchatapi.api import authentication_api
+from vrchatapi.websocket import VRChatWebSocket
+
+
+async def main():
+    configuration = vrchatapi.Configuration(username="username", password="password")
+    async with vrchatapi.ApiClient(configuration) as api_client:
+        api_client.user_agent = "ExampleProgram/0.0.1 my@email.com"
+        await authentication_api.AuthenticationApi(api_client).get_current_user()
+
+        # Reads the auth cookie + User-Agent from the logged-in client.
+        ws = VRChatWebSocket.from_client(api_client)
+
+        @ws.on("friend-online")
+        async def on_friend_online(event):
+            print("online:", event.content["user"]["displayName"])
+
+        # Or consume the same stream as an async iterator:
+        #   async for event in ws:
+        #       print(event.type, event.content)
+
+        await ws.run()  # blocks; reconnects automatically by default
+```
+
+`VRChatWebSocket` supports callback registration (`ws.on("friend-online", ...)`
+/ `@ws.on(...)`, a catch-all `ws.on_event(...)`), an async iterator over the
+same event stream, error/connect/disconnect/reconnect hooks, automatic
+reconnection with exponential backoff (`auto_reconnect=False` disables it), and
+a configurable application-level heartbeat (default 30s;
+`heartbeat_interval=None` disables it). See
+[examples/examples-source/websocket.py](examples/examples-source/websocket.py)
+and the [Websocket API reference](https://vrchat.community/websocket) for
+details.

vrchatapi_async-1.20.8/pyproject.toml

@@ -0,0 +1,6 @@
+[build-system]
+requires = [
+    "setuptools>=42",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

vrchatapi_async-1.20.8/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+[egg_info]
+tag_build = 
+tag_date = 0
+