infinitode.py 1.1.2__tar.gz → 1.1.4__tar.gz

infinitode.py-1.1.4/PKG-INFO

@@ -0,0 +1,228 @@
+Metadata-Version: 2.1
+Name: infinitode.py
+Version: 1.1.4
+Summary: A python wrapper for the Infinitode 2 API.
+Home-page: https://github.com/Sprylos/infinitode.py
+Author: Sprylos
+License: MIT
+Platform: UNKNOWN
+Description-Content-Type: text/markdown
+
+# Infinitode.py
+
+An asynchronous Python wrapper for the Infinitode-2 API using `async`-`await` syntax.
+
+---
+
+## Installation
+
+Install the library via pip:
+
+```bash
+pip install infinitode.py
+```
+
+---
+
+## Showcase
+
+### Setting Up a Session
+
+Create a session to communicate with Rainy's API. Use the `with` statement to ensure the session closes properly.
+Alternatively you can can simply call `Session.close()` once you don't need it anymore.
+
+```python
+import asyncio
+import infinitode
+
+async def main():
+    async with infinitode.Session() as API:
+        # Your API calls go here
+        pass
+
+asyncio.run(main())
+```
+
+---
+
+### Fetching Leaderboard Data
+
+Parameters:
+- `mapname`: The map identifier (e.g., "5.1" or "4.b1" or "zecred").
+- `playerid` (sometimes optional): The player's unique identifier.
+- `mode` (optional): One of `'score'`, `'waves'`. Defaults to `'score'`.
+- `difficulty` (optional): One of `'EASY'`, `'NORMAL'`, `'ENDLESS_I'`. Defaults to `'NORMAL'`.
+
+#### Player Score on a Specific Map
+
+Retrieve the score of a specific player on a particular map.
+
+```python
+score_5_1 = await API.leaderboards_rank(
+    mapname="5.1",
+    playerid="U-E9BP-FSN9-H6ENMQ",
+    mode="score",
+    difficulty="NORMAL"
+)
+```
+
+#### Top 200 Leaderboard on a Specific Map
+
+Retrieve the leaderboard of the top 200 wave scores on 5.1.
+
+```python
+leaderboard_5_1 = await API.leaderboards(
+    mapname=5.1,
+    mode="waves"
+)
+```
+
+#### Runtime Leaderboard
+
+Fetch the leaderboard displayed during gameplay. This provides additional percentile information.
+
+```python
+runtime_5_1 = await API.runtime_leaderboards(
+    mapname=5.1,
+    playerid="U-E9BP-FSN9-H6ENMQ",
+    difficulty="ENDLESS_I"
+)
+```
+
+---
+
+#### Skill Point Leaderboard
+
+Get the top 3 skill point owners. Optionally specify a `playerid`.
+
+```python
+sp_leaderboard = await API.skill_point_leaderboard(
+    playerid="U-E9BP-FSN9-H6ENMQ"
+)
+```
+
+
+#### Daily Quest Leaderboard
+
+Retrieve the top 200 players of today's daily quest or a specified date.
+
+- `date`: `YYYY-MM-DD` (string) or `datetime.datetime`.
+
+```python
+dq_leaderboard = await API.daily_quest_leaderboards("2024-12-05")
+```
+
+---
+
+### Working with Leaderboards
+
+A leaderboard is a sequence of scores with additional utility functions.
+
+#### Access Score and Leaderboard Attributes
+
+Leaderboards always have these attributes:
+- `mapname`, `mode`, `difficulty`, `total`
+
+And optionally these:
+- `date`, `season`, `player` (will return a score object)
+
+Scores always have these attributes:
+- `playerid`, `rank`, `score`, `mapname`, `mode`, `difficulty` 
+
+And optionally these:
+- `has_pfp`, `level`, `nickname`, `pinned_badge`, `position`, `top`, `total`, `player` (will return a Player object if fetched beforehand)
+
+#### Example for printing attributes, scores, and leaderboards
+
+```python
+for score in leaderboard_5_1:
+    print(score.nickname)
+    score.print_score()  # Helper method
+
+leaderboard_5_1.print_scores()
+```
+
+#### Slice a Leaderboard
+
+Retrieve a subset of the leaderboard:
+
+```python
+top_1 = leaderboard_5_1[0]
+top_10 = leaderboard_5_1[0:10]
+print(len(top_10))
+```
+
+---
+
+### Player Information
+
+#### Fetch Player Data
+
+Retrieve detailed player information.
+
+```python
+player = await API.player("U-E9BP-FSN9-H6ENMQ")
+```
+
+Attributes include:
+- `playerid`, `nickname`, `level`, `xp`, `season_level`, `total_score`, and many more.
+
+#### Get Player Scores
+
+Use the `score` method to access specific map scores.
+
+```python
+player.score(5.1).print_score()
+```
+
+#### Fetch Daily Quest and Skill Point Scores
+
+Use additional API calls to retrieve daily quest and skill point scores:
+
+```python
+await player.fetch_daily_quest(API)
+await player.fetch_skill_point(API)
+
+print(player.daily_quest.rank, player.skill_point.score)
+```
+
+---
+
+### Beta Scores
+
+Almost all API calls support an additional `beta` boolean parameter. This will make a request to the beta servers instead. No guarantees for it working.
+
+```python
+leaderboard_5_1 = await API.leaderboards(mapname=5.1, mode='waves', beta=True)
+```
+
+
+### Logging
+
+Set up logging to monitor requests and responses. 
+
+- `INFO`: Logs every request.
+- `DEBUG`: Logs server responses.
+
+```python
+import infinitode
+import asyncio
+import logging
+
+logging.basicConfig(level=logging.INFO)
+
+async def main():
+    async with infinitode.Session() as API:
+        await API.leaderboards("6.3")
+
+asyncio.run(main())
+```
+
+---
+
+### Notes
+
+- Some data (e.g., seasonal leaderboard, players) require additional parsing and will take longer to process.
+- Do not abuse this API wrapper for any kind of malicious action.
+
+

infinitode.py-1.1.4/README.md

@@ -0,0 +1,216 @@
+# Infinitode.py
+
+An asynchronous Python wrapper for the Infinitode-2 API using `async`-`await` syntax.
+
+---
+
+## Installation
+
+Install the library via pip:
+
+```bash
+pip install infinitode.py
+```
+
+---
+
+## Showcase
+
+### Setting Up a Session
+
+Create a session to communicate with Rainy's API. Use the `with` statement to ensure the session closes properly.
+Alternatively you can can simply call `Session.close()` once you don't need it anymore.
+
+```python
+import asyncio
+import infinitode
+
+async def main():
+    async with infinitode.Session() as API:
+        # Your API calls go here
+        pass
+
+asyncio.run(main())
+```
+
+---
+
+### Fetching Leaderboard Data
+
+Parameters:
+- `mapname`: The map identifier (e.g., "5.1" or "4.b1" or "zecred").
+- `playerid` (sometimes optional): The player's unique identifier.
+- `mode` (optional): One of `'score'`, `'waves'`. Defaults to `'score'`.
+- `difficulty` (optional): One of `'EASY'`, `'NORMAL'`, `'ENDLESS_I'`. Defaults to `'NORMAL'`.
+
+#### Player Score on a Specific Map
+
+Retrieve the score of a specific player on a particular map.
+
+```python
+score_5_1 = await API.leaderboards_rank(
+    mapname="5.1",
+    playerid="U-E9BP-FSN9-H6ENMQ",
+    mode="score",
+    difficulty="NORMAL"
+)
+```
+
+#### Top 200 Leaderboard on a Specific Map
+
+Retrieve the leaderboard of the top 200 wave scores on 5.1.
+
+```python
+leaderboard_5_1 = await API.leaderboards(
+    mapname=5.1,
+    mode="waves"
+)
+```
+
+#### Runtime Leaderboard
+
+Fetch the leaderboard displayed during gameplay. This provides additional percentile information.
+
+```python
+runtime_5_1 = await API.runtime_leaderboards(
+    mapname=5.1,
+    playerid="U-E9BP-FSN9-H6ENMQ",
+    difficulty="ENDLESS_I"
+)
+```
+
+---
+
+#### Skill Point Leaderboard
+
+Get the top 3 skill point owners. Optionally specify a `playerid`.
+
+```python
+sp_leaderboard = await API.skill_point_leaderboard(
+    playerid="U-E9BP-FSN9-H6ENMQ"
+)
+```
+
+
+#### Daily Quest Leaderboard
+
+Retrieve the top 200 players of today's daily quest or a specified date.
+
+- `date`: `YYYY-MM-DD` (string) or `datetime.datetime`.
+
+```python
+dq_leaderboard = await API.daily_quest_leaderboards("2024-12-05")
+```
+
+---
+
+### Working with Leaderboards
+
+A leaderboard is a sequence of scores with additional utility functions.
+
+#### Access Score and Leaderboard Attributes
+
+Leaderboards always have these attributes:
+- `mapname`, `mode`, `difficulty`, `total`
+
+And optionally these:
+- `date`, `season`, `player` (will return a score object)
+
+Scores always have these attributes:
+- `playerid`, `rank`, `score`, `mapname`, `mode`, `difficulty` 
+
+And optionally these:
+- `has_pfp`, `level`, `nickname`, `pinned_badge`, `position`, `top`, `total`, `player` (will return a Player object if fetched beforehand)
+
+#### Example for printing attributes, scores, and leaderboards
+
+```python
+for score in leaderboard_5_1:
+    print(score.nickname)
+    score.print_score()  # Helper method
+
+leaderboard_5_1.print_scores()
+```
+
+#### Slice a Leaderboard
+
+Retrieve a subset of the leaderboard:
+
+```python
+top_1 = leaderboard_5_1[0]
+top_10 = leaderboard_5_1[0:10]
+print(len(top_10))
+```
+
+---
+
+### Player Information
+
+#### Fetch Player Data
+
+Retrieve detailed player information.
+
+```python
+player = await API.player("U-E9BP-FSN9-H6ENMQ")
+```
+
+Attributes include:
+- `playerid`, `nickname`, `level`, `xp`, `season_level`, `total_score`, and many more.
+
+#### Get Player Scores
+
+Use the `score` method to access specific map scores.
+
+```python
+player.score(5.1).print_score()
+```
+
+#### Fetch Daily Quest and Skill Point Scores
+
+Use additional API calls to retrieve daily quest and skill point scores:
+
+```python
+await player.fetch_daily_quest(API)
+await player.fetch_skill_point(API)
+
+print(player.daily_quest.rank, player.skill_point.score)
+```
+
+---
+
+### Beta Scores
+
+Almost all API calls support an additional `beta` boolean parameter. This will make a request to the beta servers instead. No guarantees for it working.
+
+```python
+leaderboard_5_1 = await API.leaderboards(mapname=5.1, mode='waves', beta=True)
+```
+
+
+### Logging
+
+Set up logging to monitor requests and responses. 
+
+- `INFO`: Logs every request.
+- `DEBUG`: Logs server responses.
+
+```python
+import infinitode
+import asyncio
+import logging
+
+logging.basicConfig(level=logging.INFO)
+
+async def main():
+    async with infinitode.Session() as API:
+        await API.leaderboards("6.3")
+
+asyncio.run(main())
+```
+
+---
+
+### Notes
+
+- Some data (e.g., seasonal leaderboard, players) require additional parsing and will take longer to process.
+- Do not abuse this API wrapper for any kind of malicious action.

{infinitode.py-1.1.2 → infinitode.py-1.1.4}/infinitode/__init__.py

@@ -7,10 +7,10 @@ An asynchronous wrapper for the Infinitode API.
 
 __author__ = "Sprylos"
 __title__ = "infinitode.py"
-__version__ = "1.1.2"
+__version__ = "1.1.4"
 __license__ = """MIT License
 
-Copyright (c) 2024 Sprylos
+Copyright (c) 2025 Sprylos
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal