ddapi 0.7.1__tar.gz → 0.8.0__tar.gz

{ddapi-0.7.1 → ddapi-0.8.0}/LICENSE

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

{ddapi-0.7.1 → ddapi-0.8.0}/PKG-INFO

@@ -1,49 +1,67 @@
-Metadata-Version: 2.1
-Name: ddapi
-Version: 0.7.1
-Summary: DDnet api
-Home-page: https://github.com/ByFox213/ddapi
-Author: ByFox
-Project-URL: Github, https://github.com/ByFox213/ddapi
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-
-ddapi is an api from the ddnet and qwik website
-## Installation
-
-```bash
-  pip install ddapi
-```
-or
-```bash
-  pip install git+https://github.com/ByFox213/ddapi
-```
-    
-## Usage/Examples
-
-DDnet
-```python
-import asyncio
-from ddapi import DDnetApi, DDPlayer
-
-
-async def main():
-    obj = DDnetApi()
-    nickname = "Cor"
-    user: DDPlayer = await obj.player(nickname)
-    if user is None:
-        return "Player not found"
-    print(f"{user.player}: {user.points.points}")
-    # Cor: 31473 
-    await obj.close()  # Closing client Not necessary
-    assert isinstance(user, DDPlayer)
-
-
-asyncio.run(main())
-```
-tested on python 3.11
-[other examples](https://github.com/ByFox213/ddapi/tree/main/example)
+Metadata-Version: 2.2
+Name: ddapi
+Version: 0.8.0
+Summary: DDnet api
+Home-page: https://github.com/ByFox213/ddapi
+Author: ByFox
+Project-URL: Github, https://github.com/ByFox213/ddapi
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: project-url
+Dynamic: requires-python
+Dynamic: summary
+
+ddapi is an api from the ddnet and qwik website
+
+## Installation
+
+```bash
+  pip install ddapi
+```
+
+or
+
+```bash
+  pip install git+https://github.com/ByFox213/ddapi
+```
+
+## Usage/Examples
+
+DDnet
+
+```python
+import asyncio
+from ddapi import DDnetApi, DDPlayer
+
+
+async def main():
+    obj = DDnetApi()
+    nickname = "Cor"
+    user: DDPlayer = await obj.player(nickname)
+    if user is None:
+        return "Player not found"
+
+    print(f"{user.player}: {user.points.points}")
+    # Cor: 31473 
+    await obj.close()  # Closing client Not necessary
+    assert isinstance(user, DDPlayer)
+
+
+asyncio.run(main())
+```
+
+Tested on Python
+| 3.9 | 3.10 | 3.11 | 3.12 |
+|-----|------|------|------|
+| ? | ? | ✅ | ✅ |
+
+[other examples](https://github.com/ByFox213/ddapi/tree/main/example)

{ddapi-0.7.1 → ddapi-0.8.0}/README.md

@@ -1,35 +1,45 @@
-ddapi is an api from the ddnet and qwik website
-## Installation
-
-```bash
-  pip install ddapi
-```
-or
-```bash
-  pip install git+https://github.com/ByFox213/ddapi
-```
-    
-## Usage/Examples
-
-DDnet
-```python
-import asyncio
-from ddapi import DDnetApi, DDPlayer
-
-
-async def main():
-    obj = DDnetApi()
-    nickname = "Cor"
-    user: DDPlayer = await obj.player(nickname)
-    if user is None:
-        return "Player not found"
-    print(f"{user.player}: {user.points.points}")
-    # Cor: 31473 
-    await obj.close()  # Closing client Not necessary
-    assert isinstance(user, DDPlayer)
-
-
-asyncio.run(main())
-```
-tested on python 3.11
-[other examples](https://github.com/ByFox213/ddapi/tree/main/example)
+ddapi is an api from the ddnet and qwik website
+
+## Installation
+
+```bash
+  pip install ddapi
+```
+
+or
+
+```bash
+  pip install git+https://github.com/ByFox213/ddapi
+```
+
+## Usage/Examples
+
+DDnet
+
+```python
+import asyncio
+from ddapi import DDnetApi, DDPlayer
+
+
+async def main():
+    obj = DDnetApi()
+    nickname = "Cor"
+    user: DDPlayer = await obj.player(nickname)
+    if user is None:
+        return "Player not found"
+
+    print(f"{user.player}: {user.points.points}")
+    # Cor: 31473 
+    await obj.close()  # Closing client Not necessary
+    assert isinstance(user, DDPlayer)
+
+
+asyncio.run(main())
+```
+
+Tested on Python
+| 3.9 | 3.10 | 3.11 | 3.12 |
+|-----|------|------|------|
+| ? | ? | ✅ | ✅ |
+
+[other examples](https://github.com/ByFox213/ddapi/tree/main/example)

{ddapi-0.7.1 → ddapi-0.8.0}/ddapi/ddapi/__init__.py

@@ -1,7 +1,7 @@
-"""the module is made for the convenience of users to download and use"""
-from .main import DDnetApi, DDstats
-from .dataclass import *
-
-__version__ = "0.6.0"
-__author__ = 'ByFox'
-__LICENSE__ = "MIT"
+"""the module is made for the convenience of users to download and use"""
+from .main import DDnetApi, DDstats, Status
+from .scheme import *
+
+__version__ = "0.8.0"
+__author__ = 'ByFox'
+__LICENSE__ = "MIT"

ddapi-0.7.1/ddapi/ddapi/deflt.py → ddapi-0.8.0/ddapi/ddapi/api.py

@@ -1,64 +1,68 @@
-from abc import ABC
-from typing import Union, Optional, TypeVar, Type, Any
-
-import aiohttp
-from aiohttp import ClientSession, ClientConnectorError
-from aiohttp.typedefs import DEFAULT_JSON_DECODER
-
-ModelType = TypeVar('ModelType', bound='Model')
-
-
-class API(ABC):
-    def __init__(
-            self,
-            session: ClientSession = None,
-            json_loads: Any = DEFAULT_JSON_DECODER
-    ):
-        self.session = session
-        self.json_loads = json_loads
-
-    @staticmethod
-    def powered() -> str:
-        """Return an empty string."""
-        return ''
-
-    async def _get(self, url: str) -> Union[dict, None]:
-        """Send a GET request to the given URL and return the response as JSON."""
-        if self.session is None:
-            self.session = aiohttp.ClientSession()
-        try:
-            async with self.session.get(url) as req:
-                if req.status == 200:
-                    return await req.json(loads=self.json_loads)
-                return
-        except ClientConnectorError:
-            return
-
-    async def _generate_model_instance(
-            self,
-            url: str,
-            model: Type[ModelType],
-            k: str = None
-    ) -> Optional[ModelType]:
-        """Generate a model instance from the given URL and optional keyword arguments.
-
-        Args:
-            url (str): The URL to fetch data from.
-            model (Type[ModelType]): The model class to instantiate.
-            k (str, optional): An optional keyword to wrap the data in a dictionary.
-
-        Returns:
-            Optional[ModelType]: A model instance.
-        """
-        dat = await self._get(url)
-        if dat is None or not dat:
-            return
-
-        data_to_pass = {k: dat} if k else dat
-        return model(**data_to_pass)
-
-    async def close(self) -> None:
-        """Close the aiohttp session."""
-        if self.session:
-            await self.session.close()
-            self.session = None
+from abc import ABC
+from typing import Optional, TypeVar, Type, Any
+
+import aiohttp
+from aiohttp import ClientSession, ClientConnectorError
+from aiohttp.typedefs import DEFAULT_JSON_DECODER
+
+ModelType = TypeVar('ModelType', bound='Model')
+
+
+class API(ABC):
+    def __init__(
+            self,
+            session: ClientSession = None,
+            json_loads: Any = DEFAULT_JSON_DECODER
+    ):
+        self.__session = session
+        self.json_loads = json_loads
+
+    @staticmethod
+    def powered() -> None:
+        return None
+
+    async def _get(self, url: str) -> Optional[dict]:
+        """Send a GET request to the given URL and return the response as JSON."""
+        if self.__session is None:
+            self.__session = aiohttp.ClientSession()
+
+        try:
+            async with self.__session.get(url) as req:
+                if req.status == 200:
+                    return await req.json(loads=self.json_loads)
+                return
+        except ClientConnectorError:
+            return
+
+    async def _generate_model_instance(
+            self,
+            url: str,
+            model: Type[ModelType],
+            k: Optional[str] = None
+    ) -> Optional[ModelType]:
+        """Generate a model instance from the given URL and optional keyword arguments.
+
+        Args:
+            url (str): The URL to fetch data from.
+            model (Type[ModelType]): The model class to instantiate.
+            k (str, optional): An optional keyword to wrap the data in a dictionary.
+
+        Returns:
+            Optional[ModelType]: A model instance.
+        """
+        dat = await self._get(url)
+        if dat is None or not dat:
+            return
+
+        data_to_pass = {k: dat} if k is not None else dat
+        return model(**data_to_pass)
+
+    async def is_closed(self) -> bool:
+        """True is closed, False otherwise."""
+        return self.__session is None or self.__session.closed
+
+    async def close(self) -> None:
+        """Close the aiohttp session."""
+        if self.__session is not None:
+            await self.__session.close()
+        self.__session = None

ddapi-0.8.0/ddapi/ddapi/main.py

@@ -0,0 +1,173 @@
+from typing import Union
+from urllib.parse import quote
+
+from .api import API
+from .scheme import DDPlayer, Master, Query, DMap, DDStatus, Player, MasterTw, ServerTwOne, ChartEnum, Charts
+
+__all__ = (
+    "DDnetApi",
+    "DDstats",
+    "Status"
+)
+
+
+class DDnetApi(API):
+    def __init__(self):
+        super().__init__()
+        self.domain = "ddnet.org"
+
+    @staticmethod
+    def powered() -> str:
+        return DDnetApi().domain
+
+    async def player(self, player_name: str) -> DDPlayer:
+        """Fetch player data from the API and return it as a dictionary."""
+        return await self._generate_model_instance(
+            f"https://{self.domain}/players/?json2={quote(player_name)}",
+            DDPlayer
+        )
+
+    async def status(self) -> Union[DDStatus, None]:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/status/json/stats.json",
+            DDStatus
+        )
+
+    async def query(self, player: str) -> Union[Query, None]:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/players/?query={quote(player)}",
+            Query,
+            "data"
+        )
+
+    async def master(self) -> Union[Master, None]:
+        return await self._generate_model_instance(
+            f"https://master1.{self.domain}/ddnet/15/servers.json",
+            Master
+        )
+
+    async def map(self, map_name: str) -> Union[DMap, None]:
+        return await self._generate_model_instance(
+            f"https://{self.domain}/maps/?json={quote(map_name)}",
+            DMap
+        )
+
+
+class DDstats(API):
+    def __init__(self):
+        super().__init__()
+        self.domain = 'ddstats.tw'
+
+    @staticmethod
+    def powered() -> str:
+        return DDstats().domain
+
+    async def player(self, player_name: str) -> Player:
+        """Fetch player data from the API and return it as a dictionary."""
+        return await self._generate_model_instance(
+            f"https://{self.domain}/player/json?player={quote(player_name)}",
+            Player
+        )
+
+
+class Status(API):
+    def __init__(self):
+        super().__init__()
+        self.domain = 'status.tw'
+
+    @staticmethod
+    def powered() -> str:
+        return Status().domain
+
+    async def info(self) -> None:
+        # https://api.status.tw/info
+        raise NotImplementedError()
+
+    async def master_bans(self) -> None:
+        # https://api.status.tw/master/bans/list
+        raise NotImplementedError()
+
+    async def map_list(self) -> None:
+        # https://api.status.tw/map/list
+        raise NotImplementedError()
+
+    async def map(self, name: str) -> None:
+        # https://api.status.tw/map/name/{name}
+        raise NotImplementedError()
+
+    async def gametype_list(self) -> None:
+        # https://api.status.tw/gametype/list
+        raise NotImplementedError()
+
+    async def gametype(self, name: str) -> None:
+        # https://api.status.tw/gametype/name/{name}
+        raise NotImplementedError()
+
+    async def version_list(self) -> None:
+        # https://api.status.tw/version/list
+        raise NotImplementedError()
+
+    async def version(self, name: str) -> None:
+        # https://api.status.tw/version/name/{name}
+        raise NotImplementedError()
+
+    async def server_list(self) -> MasterTw:
+        """Fetch player data from the API and return it as a dictionary."""
+        return await self._generate_model_instance(
+            f"https://api.{self.domain}/server/list",
+            MasterTw,
+            "servers"
+        )
+
+    async def server(self, ip: str, port: Union[int, str]) -> ServerTwOne:
+        return await self._generate_model_instance(
+            f"https://api.{self.domain}/server/{quote(ip)}/{port}",
+            ServerTwOne,
+        )
+
+    async def server_charts(self, ip: str, port: Union[int, str], chart: ChartEnum = ChartEnum.day) -> Charts:
+        return await self._generate_model_instance(
+            f"https://api.{self.domain}/server/{quote(ip)}/{port}/chart/{chart}",
+            Charts,
+            "charts"
+        )
+
+    async def server_history(self, ip: str, port: Union[int, str]) -> None:
+        # https://api.status.tw/server/{ip}/{port}/history
+        raise NotImplementedError()
+
+    async def server_stats(self, ip: str, port: Union[int, str]) -> None:
+        # https://api.status.tw/server/{ip}/{port}/stats
+        raise NotImplementedError()
+
+    async def clan_list(self) -> None:
+        # https://api.status.tw/clan/list
+        raise NotImplementedError()
+
+    async def clan(self, name: str) -> None:
+        # https://api.status.tw/clan/name/{name}
+        raise NotImplementedError()
+
+    async def player_list(self) -> None:
+        # https://api.status.tw/player/list
+        raise NotImplementedError()
+
+    async def player(self, name: str) -> None:
+        # https://api.status.tw/player/name/{name}
+        raise NotImplementedError()
+
+    async def player_history(self, name: str) -> None:
+        # https://api.status.tw/player/name/{name}/history
+        raise NotImplementedError()
+
+    async def stats(self) -> None:
+        # https://api.status.tw/stats
+        raise NotImplementedError()
+
+    async def stats_players(self, t: str) -> None:
+        # https://api.status.tw/stats/players/day week month
+        raise NotImplementedError()
+
+    async def stats_servers(self, t: str) -> None:
+        # https://api.status.tw/stats/servers/week month
+        raise NotImplementedError()

ddapi-0.8.0/ddapi/ddapi/scheme/__init__.py

@@ -0,0 +1,3 @@
+from .ddnet import *
+from .status_tw import *
+from .ddstats_tw import *