ddapi 0.6.0__tar.gz → 0.7.1__tar.gz

{ddapi-0.6.0 → ddapi-0.7.1}/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.6.0 → ddapi-0.7.1}/PKG-INFO

@@ -1,49 +1,49 @@
-Metadata-Version: 2.1
-Name: ddapi
-Version: 0.6.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
-
-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())
-```
-
-[other examples](https://github.com/ByFox213/ddapi/tree/main/example)
+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)

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

@@ -1,35 +1,35 @@
-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())
-```
-
-[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.11
+[other examples](https://github.com/ByFox213/ddapi/tree/main/example)

{ddapi-0.6.0 → ddapi-0.7.1}/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, DDStatsDB
-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
+from .dataclass import *
+
+__version__ = "0.6.0"
+__author__ = 'ByFox'
+__LICENSE__ = "MIT"

ddapi-0.7.1/ddapi/ddapi/dataclass.py

@@ -0,0 +1,461 @@
+# pylint: disable-all
+from collections import Counter
+from datetime import datetime
+from typing import Optional, Union, Any
+from pydantic import BaseModel, Field
+
+rm_list = ["DD-Persian", "/vDQMHSss8W", '']
+
+
+# ddnet
+class DPoints(BaseModel):
+    total: int
+    points: Optional[int] = Field(default=None)
+    rank: Optional[int] = Field(default=None)
+
+
+class MaxFinishes(BaseModel):
+    rank: int
+    player: str
+    num: int
+    time: float
+    min_timestamp: int
+    max_timestamp: int
+
+
+class DDRanks(BaseModel):
+    rank: int
+    player: str
+    time: float
+    timestamp: int
+    country: str
+
+
+class DDTeamRanks(BaseModel):
+    rank: int
+    players: list[str]
+    time: float
+    timestamp: int
+    country: str
+
+
+class DMap(BaseModel):
+    name: str
+    website: str
+    thumbnail: str
+    web_preview: str
+    type: str
+    points: int
+    difficulty: int
+    mapper: str
+    release: Optional[int] = None
+    median_time: float
+    first_finish: int
+    last_finish: int
+    finishes: int
+    finishers: int
+    biggest_team: int
+    width: int
+    height: int
+    tiles: list[str]
+    team_ranks: list[DDTeamRanks]
+    ranks: list[DDRanks]
+    max_finishes: list[MaxFinishes]
+
+
+class DRank(BaseModel):
+    points: Optional[int] = None
+    rank: Optional[int] = None
+
+
+class FirstFinish(BaseModel):
+    timestamp: float
+    map: str
+    time: float
+
+
+class LastFinish(BaseModel):
+    timestamp: float
+    map: str
+    time: float
+    country: str
+    type: Optional[str] = None
+
+
+class FavoritePartner(BaseModel):
+    name: str
+    finishes: int
+
+
+class DData(BaseModel):
+    points: Optional[DPoints] = Field(default=None)
+    team_rank: Optional[DRank] = Field(default=None)
+    rank: Optional[DRank] = Field(default=None)
+    maps: Optional[dict] = Field(default=None)
+
+
+class DDType(BaseModel):
+    Novice: Optional[DData] = None
+    Moderate: Optional[DData] = None
+    Brutal: Optional[DData] = None
+    Insane: Optional[DData] = None
+    Dummy: Optional[DData] = None
+    DDmaX_Easy: Optional[DData] = Field(default=None, validation_alias='DDmaX.Easy')
+    DDmaX_Next: Optional[DData] = Field(default=None, validation_alias='DDmaX.Next')
+    DDmaX_Nut: Optional[DData] = Field(default=None, validation_alias='DDmaX.Nut')
+    DDmaX_Pro: Optional[DData] = Field(default=None, validation_alias='DDmaX.Pro')
+    Oldschool: Optional[DData] = Field(default=None)
+    Race: Optional[DData] = None
+    Solo: Optional[DData] = None
+    total: Optional[DData] = None
+
+
+class Activity(BaseModel):
+    date: str
+    hours_played: int
+
+
+class FavoriteServer(BaseModel):
+    server: str
+
+
+class DDPlayer(BaseModel):
+    player: str
+    points: DPoints
+    team_rank: Optional[DRank] = None
+    rank: Optional[DRank] = None
+    points_last_year: Optional[DRank] = None
+    points_last_month: Optional[DRank] = None
+    points_last_week: Optional[DRank] = None
+    favorite_server: FavoriteServer
+    first_finish: FirstFinish
+    last_finishes: list[LastFinish]
+    favorite_partners: Optional[list[FavoritePartner]] = None
+    types: DDType
+    activity: list[Activity]
+    hours_played_past_365_days: int
+
+
+# ddstats.tw
+
+class PData(BaseModel):
+    rank: int
+    points: int
+
+
+class PPoints(BaseModel):
+    Novice: Optional[PData] = None
+    Moderate: Optional[PData] = None
+    Brutal: Optional[PData] = None
+    Insane: Optional[PData] = None
+    Dummy: Optional[PData] = None
+    DDmaX_Easy: Optional[PData] = Field(default=None, validation_alias='DDmaX.Easy')
+    DDmaX_Next: Optional[PData] = Field(default=None, validation_alias='DDmaX.Next')
+    DDmaX_Nut: Optional[PData] = Field(default=None, validation_alias='DDmaX.Nut')
+    DDmaX_Pro: Optional[PData] = Field(default=None, validation_alias='DDmaX.Pro')
+    Oldschool: Optional[PData] = None
+    Race: Optional[PData] = None
+    Solo: Optional[PData] = None
+    total: Optional[PData] = None
+
+
+class PointG(BaseModel):
+    date: str
+    points: int
+    rank_points: int
+    team_points: int
+
+
+class Profile(BaseModel):
+    name: str
+    points: int
+    clan: str
+    country: int
+    skin_name: str
+    skin_color_body: Optional[int] = None
+    skin_color_feet: Optional[int] = None
+
+
+class DDMap(BaseModel):
+    map: str
+    server: str
+    points: int
+    stars: int
+    mapper: str
+    timestamp: Optional[datetime] = None
+
+
+class RecentFinishes(BaseModel):
+    map: DDMap
+    time: float
+    timestamp: datetime
+    server: str
+    cp1: float
+    cp2: float
+    cp3: float
+    cp4: float
+    cp5: float
+    cp6: float
+    cp7: float
+    cp8: float
+    cp9: float
+    cp10: float
+    cp11: float
+    cp12: float
+    cp13: float
+    cp14: float
+    cp15: float
+    cp16: float
+    cp17: float
+    cp18: float
+    cp19: float
+    cp20: float
+    cp21: float
+    cp22: float
+    cp23: float
+    cp24: float
+    cp25: float
+
+
+class FavouriteTeammates(BaseModel):
+    name: str
+    ranks_together: int
+
+
+class Finishes(BaseModel):
+    map: DDMap
+    name: str
+    time: float
+    timestamp: Optional[datetime]
+    server: str
+    rank: int
+    team_rank: Optional[int] = None
+    seconds_played: Optional[int] = None
+
+
+class UnfinishedMap(BaseModel):
+    map: DDMap
+    finishes: int
+    finishes_rank: Optional[int] = None
+    median_time: Optional[float] = None
+
+
+class Points(BaseModel):
+    weekly_points: Optional[PData] = None
+    monthly_points: Optional[PData] = None
+    yearly_points: Optional[PData] = None
+    points: PPoints
+    rank_points: PPoints
+    team_points: PPoints
+
+
+class RecentActivity(BaseModel):
+    name: str
+    date: str
+    map_name: str
+    map: DDMap | None = Field(default=None)
+    seconds_played: int
+
+
+class RecentPlayerInfo(BaseModel):
+    name: str
+    clan: str
+    country: int
+    skin_name: Optional[str] = None
+    skin_color_body: Optional[int] = None
+    skin_color_feet: Optional[int] = None
+    last_seen: str
+    seconds_played: int
+
+
+class MostPlayedMaps(BaseModel):
+    map_name: str
+    seconds_played: int
+    map: Optional[DDMap] = None
+
+
+class MostPlayed(BaseModel):
+    key: str
+    seconds_played: int
+
+
+class PlaytimePerMonth(BaseModel):
+    year_month: str
+    month: str
+    seconds_played: int
+
+
+class FavouriteRank1sTeammates(BaseModel):
+    name: str
+    ranks_together: int
+
+
+class AllTop10s(BaseModel):
+    map: DDMap
+    name: str
+    time: float
+    rank: int
+    team_rank: int | None = None
+    team_time: float | None = None
+
+
+class RecentTop10s(BaseModel):
+    rank_type: str
+    map: str
+    time: float
+    rank: int
+    timestamp: Optional[datetime]
+    server: str
+
+
+class Player(BaseModel):
+    points_graph: list[PointG]
+    recent_finishes: list[RecentFinishes]
+    favourite_teammates: Optional[list[FavouriteTeammates]] = None
+    profile: Profile
+    is_mapper: bool
+    finishes: list[Finishes]
+    unfinished_maps: Optional[list[UnfinishedMap]] = None
+    points: Points
+    recent_activity: Optional[list[RecentActivity]] = None
+    recent_player_info: Optional[list[RecentPlayerInfo]] = None
+    most_played_maps: Optional[list[MostPlayedMaps]] = None
+    most_played_gametypes: Optional[list[MostPlayed]] = None
+    most_played_categories: Optional[list[MostPlayed]] = None
+    most_played_locations: Optional[list[MostPlayed]] = None
+    playtime_per_month: list[PlaytimePerMonth]
+    favourite_rank1s_teammates: Optional[list[FavouriteRank1sTeammates]] = None
+    all_top_10s: Optional[list[AllTop10s]] = None
+    recent_top_10s: Optional[list[RecentTop10s]] = None
+
+
+class Skin(BaseModel):
+    name: Optional[str] = None
+    color_body: Optional[int] = None
+    color_feet: Optional[int] = None
+
+
+class Client(BaseModel):
+    name: str
+    clan: str
+    country: int
+    score: int
+    is_player: Optional[bool] = None
+    skin: Optional[Skin] = None
+    afk: Optional[bool] = None
+    team: Optional[int] = None
+
+
+class Map(BaseModel):
+    name: str
+    sha256: Optional[str] = None
+    size: Optional[int] = None
+
+
+class Community(BaseModel):
+    id: str
+    icon: str
+    admin: list[str]
+    public_key: Optional[str] = None
+    signature: Optional[str] = None
+
+
+class Info(BaseModel):
+    max_clients: int
+    max_players: int
+    passworded: bool
+    game_type: str
+    name: str
+    map: Map
+    version: str
+    clients: Optional[list[Client]] = None
+    requires_login: Optional[bool] = None
+    community: Optional[Community] = None
+
+    def __len__(self) -> int:
+        return len(self.clients)
+
+
+class Server(BaseModel):
+    addresses: Union[list, str]
+    location: str = Field(default=None)
+    info: Info
+
+    def __len__(self) -> int:
+        return self.count_client
+
+    @property
+    def count_client(self) -> int:
+        if self.info.clients is not None:
+            return len(self.info.clients)
+        return 0
+
+
+class Master(BaseModel):
+    servers: list[Server]
+
+    def __len__(self) -> int:
+        return len(self.servers)
+
+    def get_clans(self, rm: list[str] = None) -> list[tuple[Any, int]]:
+        remove_list = rm_list.copy() if rm is None else rm
+        if not self.servers:
+            return []
+        dat: Counter[Any] = Counter(
+            client.clan
+            for server in self.servers
+            for client in server.info.clients
+            if client != ''
+        )
+        for i in remove_list:
+            del dat[i]
+        return sorted(dat.items(), key=lambda x: x[1], reverse=True)
+
+    @property
+    def count_servers(self) -> list:
+        return sorted(
+            (
+                (i.count_client, i.addresses[0], i.info.game_type, i.info.name)
+                if isinstance(i.addresses, list)
+                else (i.count_client, i.addresses, i.info.game_type, i.info.name)
+                for i in self.servers
+            ), key=lambda x: x[0], reverse=True)
+
+    @property
+    def count_clients(self) -> int:
+        return sum(i.count_client for i in self.servers)
+
+
+class QueryData(BaseModel):
+    points: int
+    name: str
+
+
+class Query(BaseModel):
+    data: list[QueryData]
+
+
+class DDStatusData(BaseModel):
+    name: str = None
+    type: str = None
+    host: str = None
+    location: str = None
+    online4: bool = None
+    online6: bool = None
+    uptime: str = None
+    load: float = None
+    network_rx: int = None
+    network_tx: int = None
+    packets_rx: int = None
+    packets_tx: int = None
+    cpu: int = None
+    memory_total: int = None
+    memory_used: int = None
+    swap_total: int = None
+    swap_used: int = None
+    hdd_total: int = None
+    hdd_used: int = None
+
+
+class DDStatus(BaseModel):
+    servers: list[DDStatusData]