lynxpresence 4.6.2__tar.gz

lynxpresence-4.6.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 qwertyquerty
+
+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.

lynxpresence-4.6.2/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: lynxpresence
+Version: 4.6.2
+Summary: Discord RPC client written in Python
+Author: C0rn3j
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/C0rn3j/lynxpresence
+Project-URL: Repository, https://github.com/C0rn3j/lynxpresence
+Project-URL: Issues, https://github.com/C0rn3j/lynxpresence/issues
+Keywords: discord,rich presence,lynxpresence,rpc,api,wrapper,gamers,chat,irc
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Typing :: Typed
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Communications :: Chat
+Classifier: Framework :: AsyncIO
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=23.0.0; extra == "dev"
+Requires-Dist: flake8>=6.0.0; extra == "dev"
+Requires-Dist: mypy>=1.0.0; extra == "dev"
+Requires-Dist: isort>=5.12.0; extra == "dev"
+Requires-Dist: sphinx>=5.0.0; extra == "dev"
+Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == "dev"
+Dynamic: license-file
+
+Forked as upstream did not make a release in quite a while, I hope to kill this fork off in the future.
+
+I recommend doing `import lynxpresence as pypresence` to keep compatibility and allow easy switching in case upstream picks up again.
+
+> A Discord Rich Presence Client in Python? Looks like you've come to the right place.
+
+![PyPI](https://img.shields.io/pypi/v/lynxpresence.svg?style=for-the-badge)
+
+----------
+
+# Installation
+
+Install pypresence with `pip`, for the latest development version:
+
+```shell
+pip install https://github.com/C0rn3j/lynxpresence/archive/master.zip
+```
+
+For the latest stable version:
+
+```shell
+pip install lynxpresence
+```
+
+----------
+
+# Documentation
+
+> [!Note]
+> You need an **authorized app** to do anything besides rich presence!
+
+####  [pypresence Documentation](https://qwertyquerty.github.io/pypresence/html/index.html)
+####  [Discord Rich Presence Documentation](https://discord.com/developers/docs/rich-presence/how-to)
+####  [Discord RPC Documentation](https://discord.com/developers/docs/topics/rpc)
+####  [pyresence Discord Support Server](https://discord.gg/JF3kg77)
+####  [Discord API Support Server](https://discord.gg/discord-api)
+
+----------
+
+# Examples
+
+Examples can be found in the [examples](https://github.com/C0rn3j/pypresence/tree/master/examples) directory, and you can contribute your own examples if you wish, just read [examples.md](https://github.com/C0rn3j/pypresence/blob/master/examples/examples.md)!
+
+----------
+
+# Development
+
+Want to contribute? Check out the **[Development Guide](DEVELOPMENT.md)** for setup instructions, testing, code quality tools, and contribution guidelines.

lynxpresence-4.6.2/README.md

@@ -0,0 +1,48 @@
+Forked as upstream did not make a release in quite a while, I hope to kill this fork off in the future.
+
+I recommend doing `import lynxpresence as pypresence` to keep compatibility and allow easy switching in case upstream picks up again.
+
+> A Discord Rich Presence Client in Python? Looks like you've come to the right place.
+
+![PyPI](https://img.shields.io/pypi/v/lynxpresence.svg?style=for-the-badge)
+
+----------
+
+# Installation
+
+Install pypresence with `pip`, for the latest development version:
+
+```shell
+pip install https://github.com/C0rn3j/lynxpresence/archive/master.zip
+```
+
+For the latest stable version:
+
+```shell
+pip install lynxpresence
+```
+
+----------
+
+# Documentation
+
+> [!Note]
+> You need an **authorized app** to do anything besides rich presence!
+
+####  [pypresence Documentation](https://qwertyquerty.github.io/pypresence/html/index.html)
+####  [Discord Rich Presence Documentation](https://discord.com/developers/docs/rich-presence/how-to)
+####  [Discord RPC Documentation](https://discord.com/developers/docs/topics/rpc)
+####  [pyresence Discord Support Server](https://discord.gg/JF3kg77)
+####  [Discord API Support Server](https://discord.gg/discord-api)
+
+----------
+
+# Examples
+
+Examples can be found in the [examples](https://github.com/C0rn3j/pypresence/tree/master/examples) directory, and you can contribute your own examples if you wish, just read [examples.md](https://github.com/C0rn3j/pypresence/blob/master/examples/examples.md)!
+
+----------
+
+# Development
+
+Want to contribute? Check out the **[Development Guide](DEVELOPMENT.md)** for setup instructions, testing, code quality tools, and contribution guidelines.

lynxpresence-4.6.2/lynxpresence/__init__.py

@@ -0,0 +1,15 @@
+"""
+Python RPC Client for Discord
+"""
+
+from .baseclient import BaseClient
+from .client import AioClient, Client
+from .exceptions import *
+from .presence import AioPresence, Presence
+from .types import ActivityType, StatusDisplayType
+
+__title__ = "lynxpresence"
+__author__ = "C0rn3j"
+__copyright__ = "Copyright 2018 - 2025"
+__license__ = "MIT"
+__version__ = "4.6.2"

lynxpresence-4.6.2/lynxpresence/baseclient.py

@@ -0,0 +1,162 @@
+from __future__ import annotations
+
+import asyncio
+import inspect
+import json
+import struct
+import sys
+
+# TODO: Get rid of this import * lol
+from .exceptions import (
+    ConnectionTimeout,
+    DiscordError,
+    DiscordNotFound,
+    InvalidArgument,
+    InvalidID,
+    InvalidPipe,
+    PipeClosed,
+    PyPresenceException,
+    ResponseTimeout,
+    ServerError,
+)
+from .payloads import Payload
+from .utils import get_event_loop, get_ipc_path
+
+
+class BaseClient:
+
+    def __init__(self, client_id: str, **kwargs):
+        loop = kwargs.get("loop", None)
+        handler = kwargs.get("handler", None)
+        self.pipe = kwargs.get("pipe", None)
+        self.isasync = kwargs.get("isasync", False)
+        self.connection_timeout = kwargs.get("connection_timeout", 30)
+        self.response_timeout = kwargs.get("response_timeout", 10)
+
+        client_id = str(client_id)
+
+        if loop is not None:
+            self.update_event_loop(loop)
+        else:
+            self.update_event_loop(get_event_loop())
+
+        self.sock_reader: asyncio.StreamReader | None = None
+        self.sock_writer: asyncio.StreamWriter | None = None
+
+        self.client_id = client_id
+
+        if handler is not None:
+            if not inspect.isfunction(handler):
+                raise PyPresenceException("Error handler must be a function.")
+            args = inspect.getfullargspec(handler).args
+            if args[0] == "self":
+                args = args[1:]
+            if len(args) != 2:
+                raise PyPresenceException(
+                    "Error handler should only accept two arguments."
+                )
+
+            if self.isasync:
+                if not inspect.iscoroutinefunction(handler):
+                    raise InvalidArgument(
+                        "Coroutine",
+                        "Subroutine",
+                        "You are running async mode - "
+                        "your error handler should be awaitable.",
+                    )
+                err_handler = self._async_err_handle
+            else:
+                err_handler = self._err_handle
+
+            self.loop.set_exception_handler(err_handler)
+            self.handler = handler
+
+        if getattr(self, "on_event", None):  # Tasty bad code ;^)
+            self._events_on = True
+        else:
+            self._events_on = False
+
+    def update_event_loop(self, loop):
+        # noinspection PyAttributeOutsideInit
+        self.loop = loop
+        asyncio.set_event_loop(self.loop)
+
+    def _err_handle(self, loop, context: dict):
+        result = self.handler(context["exception"], context["future"])
+        if inspect.iscoroutinefunction(self.handler):
+            loop.run_until_complete(result)
+
+    # noinspection PyUnusedLocal
+    async def _async_err_handle(self, loop, context: dict):
+        await self.handler(context["exception"], context["future"])
+
+    async def read_output(self):
+        try:
+            preamble = await asyncio.wait_for(
+                self.sock_reader.read(8), self.response_timeout
+            )
+            status_code, length = struct.unpack("<II", preamble[:8])
+            data = await asyncio.wait_for(
+                self.sock_reader.read(length), self.response_timeout
+            )
+        except (BrokenPipeError, struct.error):
+            raise PipeClosed
+        except asyncio.TimeoutError:
+            raise ResponseTimeout
+        payload = json.loads(data.decode("utf-8"))
+        if payload["evt"] == "ERROR":
+            raise ServerError(payload["data"]["message"])
+        return payload
+
+    def send_data(self, op: int, payload: dict | Payload):
+        if isinstance(payload, Payload):
+            payload = payload.data
+        payload_string = json.dumps(payload)
+
+        assert (
+            self.sock_writer is not None
+        ), "You must connect your client before sending events!"
+
+        self.sock_writer.write(
+            struct.pack("<II", op, len(payload_string)) + payload_string.encode("utf-8")
+        )
+
+    async def create_reader_writer(self, ipc_path):
+        try:
+            if sys.platform == "linux" or sys.platform == "darwin":
+                self.sock_reader, self.sock_writer = await asyncio.wait_for(
+                    asyncio.open_unix_connection(ipc_path), self.connection_timeout
+                )
+            elif sys.platform == "win32":
+                self.sock_reader = asyncio.StreamReader(loop=self.loop)
+                reader_protocol = asyncio.StreamReaderProtocol(
+                    self.sock_reader, loop=self.loop
+                )
+                self.sock_writer, _ = await asyncio.wait_for(
+                    self.loop.create_pipe_connection(lambda: reader_protocol, ipc_path),
+                    self.connection_timeout,
+                )
+        except FileNotFoundError:
+            raise InvalidPipe
+        except asyncio.TimeoutError:
+            raise ConnectionTimeout
+
+    async def handshake(self):
+        ipc_path = get_ipc_path(self.pipe)
+        if not ipc_path:
+            raise DiscordNotFound
+
+        await self.create_reader_writer(ipc_path)
+
+        self.send_data(0, {"v": 1, "client_id": self.client_id})
+        preamble = await self.sock_reader.read(8)
+        if len(preamble) < 8:
+            raise InvalidPipe  # this sometimes happens for some reason, perhaps discord cannot always accept all the connections?
+        code, length = struct.unpack("<ii", preamble)
+        data = json.loads(await self.sock_reader.read(length))
+        if "code" in data:
+            if data["message"] == "Invalid Client ID":
+                raise InvalidID
+            raise DiscordError(data["code"], data["message"])
+        if self._events_on:
+            self.sock_reader.feed_data = self.on_event