python-ballchasing 0.2.0__tar.gz → 0.3.0__tar.gz

python_ballchasing-0.3.0/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: python-ballchasing
+Version: 0.3.0
+Summary: A Python wrapper around the Ballchasing API
+Author-email: Rolv-Arild Braaten <rolv_arild@hotmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/Rolv-Arild/python-ballchasing
+Project-URL: Download, https://pypi.python.org/pypi/python-ballchasing
+Classifier: Programming Language :: Python :: 3.8
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Dynamic: license-file
+
+# Python Ballchasing
+An easy-to-use and comprehensive Python wrapper for the [ballchasing.com API](https://ballchasing.com/doc/api).
+
+## Installation
+You can install the library from PyPI using pip:
+```
+pip install python-ballchasing
+```
+
+## Authentication
+Before you can use the library, you need an API authentication key from ballchasing.com.
+1. Log in to [ballchasing.com](https://ballchasing.com/).
+2. Navigate to the Upload tab.
+3. Create an API key and copy it.
+   
+**Keep your API key secure and do not share it publicly.**
+
+## API
+For detailed information, please refer to the docs inside the code. For the most part it follows the API spec closely, but there are some differences.
+
+The API is exposed via the `BallchasingApi` class.
+
+Making the client:
+```python
+from ballchasing import BallchasingApi
+api = BallchasingApi("Your token here")
+```
+or equivalently
+```python
+import ballchasing
+api = ballchasing.Api("Your token here")
+```
+By default this will also ping the API to make sure it's working.
+
+---
+Some simple examples:
+```python
+# Get lots of SSL replays
+
+from ballchasing import Rank  # there's also Playlist, Season, Map, and more
+
+replays = api.get_replays(
+  min_rank=Rank.SUPERSONIC_LEGEND,
+  count=10_000  # The API limits you to 200 replays per request but the library handles this for you
+)
+
+for replay in replays:  # (replays is an iterable so you don't need to wait for all the replays to be collected)
+  ...  # Do something with the replays
+```
+
+```python
+# Get a specific replay with more detail than the iterator (including stats!)
+replay = api.get_replay("2627e02a-aa46-4e13-b66b-b76a32069a07")
+```
+
+```python
+# Get groups by the "RLCS Referee" account
+groups = api.get_groups(creator="76561199225615730")
+
+for group in groups:
+  # Download the group
+  api.download_group(
+    group_id=group["id"],
+    folder="/path/to/destination/"
+    recursive=True,  # To download all the replays and retain the group structure with subfolders
+  )
+
+  # Get replays from the group
+  replays = get_group_replays(
+    group_id=group["id"],
+    deep=True,  # To get detailed replay info
+  )
+  for replay in replays:
+    api.download_replay(replay_id=replay["id"], folder="/path/to/destination/")  # You could also download like this
+```

python_ballchasing-0.3.0/README.md

@@ -0,0 +1,75 @@
+# Python Ballchasing
+An easy-to-use and comprehensive Python wrapper for the [ballchasing.com API](https://ballchasing.com/doc/api).
+
+## Installation
+You can install the library from PyPI using pip:
+```
+pip install python-ballchasing
+```
+
+## Authentication
+Before you can use the library, you need an API authentication key from ballchasing.com.
+1. Log in to [ballchasing.com](https://ballchasing.com/).
+2. Navigate to the Upload tab.
+3. Create an API key and copy it.
+   
+**Keep your API key secure and do not share it publicly.**
+
+## API
+For detailed information, please refer to the docs inside the code. For the most part it follows the API spec closely, but there are some differences.
+
+The API is exposed via the `BallchasingApi` class.
+
+Making the client:
+```python
+from ballchasing import BallchasingApi
+api = BallchasingApi("Your token here")
+```
+or equivalently
+```python
+import ballchasing
+api = ballchasing.Api("Your token here")
+```
+By default this will also ping the API to make sure it's working.
+
+---
+Some simple examples:
+```python
+# Get lots of SSL replays
+
+from ballchasing import Rank  # there's also Playlist, Season, Map, and more
+
+replays = api.get_replays(
+  min_rank=Rank.SUPERSONIC_LEGEND,
+  count=10_000  # The API limits you to 200 replays per request but the library handles this for you
+)
+
+for replay in replays:  # (replays is an iterable so you don't need to wait for all the replays to be collected)
+  ...  # Do something with the replays
+```
+
+```python
+# Get a specific replay with more detail than the iterator (including stats!)
+replay = api.get_replay("2627e02a-aa46-4e13-b66b-b76a32069a07")
+```
+
+```python
+# Get groups by the "RLCS Referee" account
+groups = api.get_groups(creator="76561199225615730")
+
+for group in groups:
+  # Download the group
+  api.download_group(
+    group_id=group["id"],
+    folder="/path/to/destination/"
+    recursive=True,  # To download all the replays and retain the group structure with subfolders
+  )
+
+  # Get replays from the group
+  replays = get_group_replays(
+    group_id=group["id"],
+    deep=True,  # To get detailed replay info
+  )
+  for replay in replays:
+    api.download_replay(replay_id=replay["id"], folder="/path/to/destination/")  # You could also download like this
+```

{python_ballchasing-0.2.0 → python_ballchasing-0.3.0}/ballchasing/api.py

@@ -1,7 +1,8 @@
 import os
 import time
 from datetime import datetime
-from typing import Optional, Iterator, Union, List
+from pathlib import Path
+from typing import Optional, Iterator, Union, List, BinaryIO
 from urllib.parse import parse_qs, urlparse
 
 from requests import sessions, Response, ConnectionError
@@ -18,12 +19,14 @@ class BallchasingApi:
     Class for communication with ballchasing.com API (https://ballchasing.com/doc/api)
     """
 
-    def __init__(self,
-                 auth_key: str,
-                 sleep_time_on_rate_limit: Optional[float] = None,
-                 print_on_rate_limit: bool = False,
-                 base_url=None,
-                 do_initial_ping=True):
+    def __init__(
+            self,
+            auth_key: str,
+            sleep_time_on_rate_limit: Optional[float] = None,
+            print_on_rate_limit: bool = False,
+            base_url=None,
+            do_initial_ping=True
+    ):
         """
 
         :param auth_key: authentication key for API calls.
@@ -74,11 +77,12 @@ class BallchasingApi:
             self.ping()
         return self._ping_result.get("quota")
 
-    def _request(self,
-                 url_or_endpoint: str,
-                 method: str,
-                 **params
-                 ) -> Response:
+    def _request(
+            self,
+            url_or_endpoint: str,
+            method: str,
+            **params
+    ) -> Response:
         """
         Helper method for all requests.
 
@@ -92,7 +96,8 @@ class BallchasingApi:
         headers = {"Authorization": self.auth_key}
         url = f"{self.base_url}{url_or_endpoint}" if url_or_endpoint.startswith("/") else url_or_endpoint
         max_retries = 8
-        for retries in range(max_retries):
+        retries = 0
+        while True:
             try:
                 r: Response = self._session.request(method=method, url=url, headers=headers, **params)
                 if 200 <= r.status_code < 300:
@@ -108,13 +113,14 @@ class BallchasingApi:
                     elif self.sleep_time_on_rate_limit:
                         time.sleep(self.sleep_time_on_rate_limit)
                 else:
-                    r.raise_for_status()  # Raise an error for any other status code
+                    r.raise_for_status()  # Raise an error for any other status code'
             except ConnectionError as e:
                 if retries >= max_retries - 1:
                     raise e
                 s = 2 ** retries
                 print(f"Connection error, trying again in {s} seconds...")
                 time.sleep(s)
+                retries += 1
 
     def ping(self) -> dict:
         """
@@ -130,28 +136,29 @@ class BallchasingApi:
         self._ping_result = result
         return result
 
-    def get_replays(self,
-                    title: Optional[str] = None,
-                    player_name: Optional[Union[str, List[str]]] = None,
-                    player_id: Optional[Union[str, List[str]]] = None,
-                    playlist: Optional[Union[AnyPlaylist, List[AnyPlaylist]]] = None,
-                    season: Optional[Union[AnySeason, List[AnySeason]]] = None,
-                    match_result: Optional[Union[AnyMatchResult, List[AnyMatchResult]]] = None,
-                    min_rank: Optional[AnyRank] = None,
-                    max_rank: Optional[AnyRank] = None,
-                    pro: Optional[bool] = None,
-                    uploader: Optional[str] = None,
-                    group_id: Optional[Union[str, List[str]]] = None,
-                    map_id: Optional[Union[AnyMap, List[AnyMap]]] = None,
-                    created_before: Optional[Union[str, datetime]] = None,
-                    created_after: Optional[Union[str, datetime]] = None,
-                    replay_after: Optional[Union[str, datetime]] = None,
-                    replay_before: Optional[Union[str, datetime]] = None,
-                    count: int = 150,
-                    sort_by: Optional[AnyReplaySortBy] = None,
-                    sort_dir: AnySortDir = SortDir.DESCENDING,
-                    deep: bool = False
-                    ) -> Iterator[dict]:
+    def get_replays(
+            self,
+            title: Optional[str] = None,
+            player_name: Optional[Union[str, List[str]]] = None,
+            player_id: Optional[Union[str, List[str]]] = None,
+            playlist: Optional[Union[AnyPlaylist, List[AnyPlaylist]]] = None,
+            season: Optional[Union[AnySeason, List[AnySeason]]] = None,
+            match_result: Optional[Union[AnyMatchResult, List[AnyMatchResult]]] = None,
+            min_rank: Optional[AnyRank] = None,
+            max_rank: Optional[AnyRank] = None,
+            pro: Optional[bool] = None,
+            uploader: Optional[str] = None,
+            group_id: Optional[Union[str, List[str]]] = None,
+            map_id: Optional[Union[AnyMap, List[AnyMap]]] = None,
+            created_before: Optional[Union[str, datetime]] = None,
+            created_after: Optional[Union[str, datetime]] = None,
+            replay_after: Optional[Union[str, datetime]] = None,
+            replay_before: Optional[Union[str, datetime]] = None,
+            count: int = 150,
+            sort_by: Optional[AnyReplaySortBy] = None,
+            sort_dir: AnySortDir = SortDir.DESCENDING,
+            deep: bool = False
+    ) -> Iterator[dict]:
         """
         This endpoint lets you filter and retrieve replays. The implementation returns an iterator.
 
@@ -230,18 +237,23 @@ class BallchasingApi:
         """
         self._request(f"/replays/{replay_id}", "PATCH", json=params)
 
-    def upload_replay(self,
-                      replay_file,
-                      visibility: Optional[AnyVisibility] = None,
-                      group: Optional[str] = None) -> dict:
+    def upload_replay(
+            self,
+            replay_file: Union[str, Path, BinaryIO],
+            visibility: Optional[AnyVisibility] = None,
+            group: Optional[str] = None
+    ) -> dict:
         """
         Use this API to upload a replay file to ballchasing.com.
 
-        :param replay_file: replay file to upload.
+        :param replay_file: replay file to upload. Can be a file path (str or Path) or a file-like object.
         :param visibility: to set the visibility of the uploaded replay.
         :param group: to upload the replay to an existing group.
         :return: the result of the POST request.
         """
+        if isinstance(replay_file, (str, Path)):
+            with open(replay_file, "rb") as f:
+                return self.upload_replay(f, visibility, group)
         return self._request(f"/v2/upload", "POST", files={"file": replay_file},
                              params={"group": group, "visibility": visibility}).json()
 
@@ -254,16 +266,17 @@ class BallchasingApi:
         """
         self._request(f"/replays/{replay_id}", "DELETE")
 
-    def get_groups(self,
-                   name: Optional[str] = None,
-                   creator: Optional[str] = None,
-                   group: Optional[str] = None,
-                   created_before: Optional[Union[str, datetime]] = None,
-                   created_after: Optional[Union[str, datetime]] = None,
-                   count: int = 200,
-                   sort_by: AnyGroupSortBy = GroupSortBy.CREATED,
-                   sort_dir: AnySortDir = SortDir.DESCENDING
-                   ) -> Iterator[dict]:
+    def get_groups(
+            self,
+            name: Optional[str] = None,
+            creator: Optional[str] = None,
+            group: Optional[str] = None,
+            created_before: Optional[Union[str, datetime]] = None,
+            created_after: Optional[Union[str, datetime]] = None,
+            count: int = 200,
+            sort_by: AnyGroupSortBy = GroupSortBy.CREATED,
+            sort_dir: AnySortDir = SortDir.DESCENDING
+    ) -> Iterator[dict]:
         """
         This endpoint lets you filter and retrieve replay groups.
 
@@ -301,12 +314,13 @@ class BallchasingApi:
             left -= len(batch)
             params["after"] = parse_qs(urlparse(next_url).query)["after"][0]
 
-    def create_group(self,
-                     name: str,
-                     player_identification: AnyPlayerIdentification,
-                     team_identification: AnyTeamIdentification,
-                     parent: Optional[str] = None
-                     ) -> dict:
+    def create_group(
+            self,
+            name: str,
+            player_identification: AnyPlayerIdentification,
+            team_identification: AnyTeamIdentification,
+            parent: Optional[str] = None
+    ) -> dict:
         """
         Use this API to create a new replay group.
 

{python_ballchasing-0.2.0 → python_ballchasing-0.3.0}/ballchasing/constants.py

@@ -1,4 +1,4 @@
-from typing import Literal, get_args, AnyStr, Union, Sequence, Optional
+from typing import Literal, get_args, AnyStr, Union
 
 AnyPlaylist = Union[
     AnyStr,
@@ -41,6 +41,7 @@ AnyRank = Union[
         "platinum-1", "platinum-2", "platinum-3",
         "diamond-1", "diamond-2", "diamond-3",
         "champion-1", "champion-2", "champion-3",
+        "grand-champion",  # Legacy. Seems to be interchangeable with "grand-champion-1"
         "grand-champion-1", "grand-champion-2", "grand-champion-3",
         "supersonic-legend"
     ],
@@ -48,9 +49,18 @@ AnyRank = Union[
 
 
 class Rank:
-    ALL = (UNRANKED, BRONZE_1, BRONZE_2, BRONZE_3, SILVER_1, SILVER_2, SILVER_3, GOLD_1, GOLD_2, GOLD_3, PLATINUM_1,
-           PLATINUM_2, PLATINUM_3, DIAMOND_1, DIAMOND_2, DIAMOND_3, CHAMPION_1, CHAMPION_2, CHAMPION_3,
-           GRAND_CHAMPION_1, GRAND_CHAMPION_2, GRAND_CHAMPION_3, SUPERSONIC_LEGEND) = _get_literals(AnyRank)
+    ALL = (
+        UNRANKED,
+        BRONZE_1, BRONZE_2, BRONZE_3,
+        SILVER_1, SILVER_2, SILVER_3,
+        GOLD_1, GOLD_2, GOLD_3,
+        PLATINUM_1, PLATINUM_2, PLATINUM_3,
+        DIAMOND_1, DIAMOND_2, DIAMOND_3,
+        CHAMPION_1, CHAMPION_2, CHAMPION_3,
+        GRAND_CHAMPION_LEGACY,
+        GRAND_CHAMPION_1, GRAND_CHAMPION_2, GRAND_CHAMPION_3,
+        SUPERSONIC_LEGEND
+    ) = _get_literals(AnyRank)
     BRONZE = (BRONZE_1, BRONZE_2, BRONZE_3)
     SILVER = (SILVER_1, SILVER_2, SILVER_3)
     GOLD = (GOLD_1, GOLD_2, GOLD_3)
@@ -65,18 +75,21 @@ AnySeason = Union[
     Literal[
         "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13", "14",
         "f1", "f2", "f3", "f4", "f5", "f6", "f7", "f8", "f9",
-        "f10", "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18"
+        "f10", "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18", "f19"
     ]
 ]
 
 
 class Season:
-    ALL = (SEASON_1, SEASON_2, SEASON_3, SEASON_4, SEASON_5, SEASON_6, SEASON_7, SEASON_8, SEASON_9, SEASON_10,
-           SEASON_11, SEASON_12, SEASON_13, SEASON_14, SEASON_1_FTP, SEASON_2_FTP, SEASON_3_FTP, SEASON_4_FTP,
-           SEASON_5_FTP, SEASON_6_FTP, SEASON_7_FTP, SEASON_8_FTP, SEASON_9_FTP, SEASON_10_FTP, SEASON_11_FTP,
-           SEASON_12_FTP, SEASON_13_FTP, SEASON_14_FTP, SEASON_15_FTP, SEASON_16_FTP, SEASON_17_FTP, SEASON_18_FTP) \
-        = _get_literals(AnySeason)
-    PAY_TO_PLAY = ALL[:14]
+    ALL = (
+        SEASON_1_LEGACY, SEASON_2_LEGACY, SEASON_3_LEGACY, SEASON_4_LEGACY, SEASON_5_LEGACY, SEASON_6_LEGACY,
+        SEASON_7_LEGACY, SEASON_8_LEGACY, SEASON_9_LEGACY, SEASON_10_LEGACY, SEASON_11_LEGACY, SEASON_12_LEGACY,
+        SEASON_13_LEGACY, SEASON_14_LEGACY,
+        SEASON_1_FTP, SEASON_2_FTP, SEASON_3_FTP, SEASON_4_FTP, SEASON_5_FTP, SEASON_6_FTP, SEASON_7_FTP,
+        SEASON_8_FTP, SEASON_9_FTP, SEASON_10_FTP, SEASON_11_FTP, SEASON_12_FTP, SEASON_13_FTP, SEASON_14_FTP,
+        SEASON_15_FTP, SEASON_16_FTP, SEASON_17_FTP, SEASON_18_FTP, SEASON_19_FTP
+    ) = _get_literals(AnySeason)
+    LEGACY = ALL[:14]
     FREE_TO_PLAY = ALL[14:]
 
 
@@ -134,13 +147,15 @@ AnyMap = Union[AnyStr, Literal[
     "chn_stadium_day_p", "chn_stadium_p", "cs_day_p", "cs_hw_p", "cs_p", "eurostadium_dusk_p", "eurostadium_night_p",
     "eurostadium_p", "eurostadium_rainy_p", "eurostadium_snownight_p", "farm_grs_p", "farm_hw_p", "farm_night_p",
     "farm_p", "farm_upsidedown_p", "ff_dusk_p", "fni_stadium_p", "haunted_trainstation_p", "hoopsstadium_p",
-    "hoopsstreet_p", "labs_circlepillars_p", "labs_corridor_p", "labs_cosmic_p", "labs_cosmic_v4_p",
-    "labs_doublegoal_p", "labs_doublegoal_v2_p", "labs_octagon_02_p", "labs_octagon_p", "labs_pillarglass_p",
-    "labs_pillarwings_p", "labs_underpass_p", "labs_underpass_v0_p", "labs_utopia_p", "music_p", "neotokyo_arcade_p",
-    "neotokyo_hax_p", "neotokyo_p", "neotokyo_standard_p", "neotokyo_toon_p", "outlaw_oasis_p", "outlaw_p",
-    "park_bman_p", "park_night_p", "park_p", "park_rainy_p", "park_snowy_p", "shattershot_p", "stadium_day_p",
-    "stadium_foggy_p", "stadium_p", "stadium_race_day_p", "stadium_winter_p", "street_p", "throwbackhockey_p",
-    "throwbackstadium_p", "trainstation_dawn_p", "trainstation_night_p", "trainstation_p", "trainstation_spooky_p",
+    "hoopsstreet_p", "ko_calavera_p", "ko_carbon_p", "ko_quadron_p", "labs_basin_p", "labs_circlepillars_p",
+    "labs_corridor_p", "labs_cosmic_p", "labs_cosmic_v4_p", "labs_doublegoal_p", "labs_doublegoal_v2_p",
+    "labs_galleon_mast_p", "labs_galleon_p", "labs_holyfield_p", "labs_holyfield_space_p", "labs_octagon_02_p",
+    "labs_octagon_p", "labs_pillarglass_p", "labs_pillarheat_p", "labs_pillarwings_p", "labs_underpass_p",
+    "labs_underpass_v0_p", "labs_utopia_p", "music_p", "neotokyo_arcade_p", "neotokyo_hax_p", "neotokyo_p",
+    "neotokyo_standard_p", "neotokyo_toon_p", "outlaw_oasis_p", "outlaw_p", "park_bman_p", "park_night_p", "park_p",
+    "park_rainy_p", "park_snowy_p", "shattershot_p", "stadium_10a_p", "stadium_day_p", "stadium_foggy_p", "stadium_p",
+    "stadium_race_day_p", "stadium_winter_p", "street_p", "swoosh_p", "throwbackhockey_p", "throwbackstadium_p",
+    "trainstation_dawn_p", "trainstation_night_p", "trainstation_p", "trainstation_spooky_p", "uf_day_p",
     "underwater_grs_p", "underwater_p", "utopiastadium_dusk_p", "utopiastadium_lux_p", "utopiastadium_p",
     "utopiastadium_snow_p", "wasteland_grs_p", "wasteland_night_p", "wasteland_night_s_p", "wasteland_p",
     "wasteland_s_p", "woods_night_p", "woods_p"
@@ -153,15 +168,17 @@ class Map:
         CHN_STADIUM_DAY_P, CHN_STADIUM_P, CS_DAY_P, CS_HW_P, CS_P, EUROSTADIUM_DUSK_P, EUROSTADIUM_NIGHT_P,
         EUROSTADIUM_P, EUROSTADIUM_RAINY_P, EUROSTADIUM_SNOWNIGHT_P, FARM_GRS_P, FARM_HW_P, FARM_NIGHT_P, FARM_P,
         FARM_UPSIDEDOWN_P, FF_DUSK_P, FNI_STADIUM_P, HAUNTED_TRAINSTATION_P, HOOPSSTADIUM_P, HOOPSSTREET_P,
-        LABS_CIRCLEPILLARS_P, LABS_CORRIDOR_P, LABS_COSMIC_P, LABS_COSMIC_V4_P, LABS_DOUBLEGOAL_P, LABS_DOUBLEGOAL_V2_P,
-        LABS_OCTAGON_02_P, LABS_OCTAGON_P, LABS_PILLARGLASS_P, LABS_PILLARWINGS_P, LABS_UNDERPASS_P,
-        LABS_UNDERPASS_V0_P, LABS_UTOPIA_P, MUSIC_P, NEOTOKYO_ARCADE_P, NEOTOKYO_HAX_P, NEOTOKYO_P, NEOTOKYO_STANDARD_P,
-        NEOTOKYO_TOON_P, OUTLAW_OASIS_P, OUTLAW_P, PARK_BMAN_P, PARK_NIGHT_P, PARK_P, PARK_RAINY_P, PARK_SNOWY_P,
-        SHATTERSHOT_P, STADIUM_DAY_P, STADIUM_FOGGY_P, STADIUM_P, STADIUM_RACE_DAY_P, STADIUM_WINTER_P, STREET_P,
-        THROWBACKHOCKEY_P, THROWBACKSTADIUM_P, TRAINSTATION_DAWN_P, TRAINSTATION_NIGHT_P, TRAINSTATION_P,
-        TRAINSTATION_SPOOKY_P, UNDERWATER_GRS_P, UNDERWATER_P, UTOPIASTADIUM_DUSK_P, UTOPIASTADIUM_LUX_P,
-        UTOPIASTADIUM_P, UTOPIASTADIUM_SNOW_P, WASTELAND_GRS_P, WASTELAND_NIGHT_P, WASTELAND_NIGHT_S_P, WASTELAND_P,
-        WASTELAND_S_P, WOODS_NIGHT_P, WOODS_P
+        KO_CALAVERA_P, KO_CARBON_P, KO_QUADRON_P, LABS_BASIN_P, LABS_CIRCLEPILLARS_P, LABS_CORRIDOR_P, LABS_COSMIC_P,
+        LABS_COSMIC_V4_P, LABS_DOUBLEGOAL_P, LABS_DOUBLEGOAL_V2_P, LABS_GALLEON_MAST_P, LABS_GALLEON_P,
+        LABS_HOLYFIELD_P, LABS_HOLYFIELD_SPACE_P, LABS_OCTAGON_02_P, LABS_OCTAGON_P, LABS_PILLARGLASS_P,
+        LABS_PILLARHEAT_P, LABS_PILLARWINGS_P, LABS_UNDERPASS_P, LABS_UNDERPASS_V0_P, LABS_UTOPIA_P, MUSIC_P,
+        NEOTOKYO_ARCADE_P, NEOTOKYO_HAX_P, NEOTOKYO_P, NEOTOKYO_STANDARD_P, NEOTOKYO_TOON_P, OUTLAW_OASIS_P, OUTLAW_P,
+        PARK_BMAN_P, PARK_NIGHT_P, PARK_P, PARK_RAINY_P, PARK_SNOWY_P, SHATTERSHOT_P, STADIUM_10A_P, STADIUM_DAY_P,
+        STADIUM_FOGGY_P, STADIUM_P, STADIUM_RACE_DAY_P, STADIUM_WINTER_P, STREET_P, SWOOSH_P, THROWBACKHOCKEY_P,
+        THROWBACKSTADIUM_P, TRAINSTATION_DAWN_P, TRAINSTATION_NIGHT_P, TRAINSTATION_P, TRAINSTATION_SPOOKY_P, UF_DAY_P,
+        UNDERWATER_GRS_P, UNDERWATER_P, UTOPIASTADIUM_DUSK_P, UTOPIASTADIUM_LUX_P, UTOPIASTADIUM_P,
+        UTOPIASTADIUM_SNOW_P, WASTELAND_GRS_P, WASTELAND_NIGHT_P, WASTELAND_NIGHT_S_P, WASTELAND_P, WASTELAND_S_P,
+        WOODS_NIGHT_P, WOODS_P
     ) = _get_literals(AnyMap)
     NAMES = (
         "Starbase ARC (Aftermath)", "Starbase ARC", "Starbase ARC (Standard)", "Champions Field (NFL)",
@@ -170,33 +187,37 @@ class Map:
         "Mannfield (Dusk)", "Mannfield (Night)", "Mannfield", "Mannfield (Stormy)", "Mannfield (Snowy)",
         "Farmstead (Pitched)", "Farmstead (Spooky)", "Farmstead (Night)", "Farmstead", "Farmstead (The Upside Down)",
         "Estadio Vida (Dusk)", "Forbidden Temple (Fire & Ice)", "Urban Central (Haunted)", "Dunk House",
-        "The Block (Dusk)", "Pillars", "Corridor", "Cosmic", "Cosmic", "Double Goal", "Double Goal", "Octagon",
-        "Octagon", "Hourglass", "Colossus", "Underpass", "Underpass", "Utopia Retro", "Neon Fields",
+        "The Block (Dusk)", "Calavera", "Carbon", "Quadron", "Basin", "Pillars", "Corridor", "Cosmic", "Cosmic",
+        "Double Goal", "Double Goal", "Galleon Retro", "Galleon", "Loophole", "Holyfield", "Octagon", "Octagon",
+        "Hourglass", "Barricade", "Colossus", "Underpass", "Underpass", "Utopia Retro", "Neon Fields",
         "Neo Tokyo (Arcade)", "Neo Tokyo (Hacked)", "Neo Tokyo", "Neo Tokyo (Standard)", "Neo Tokyo (Comic)",
         "Deadeye Canyon (Oasis)", "Deadeye Canyon", "Beckwith Park (Night)", "Beckwith Park (Midnight)",
-        "Beckwith Park", "Beckwith Park (Stormy)", "Beckwith Park (Snowy)", "Core 707", "DFH Stadium (Day)",
-        "DFH Stadium (Stormy)", "DFH Stadium", "DFH Stadium (Circuit)", "DFH Stadium (Snowy)",
-        "Sovereign Heights (Dusk)", "Throwback Stadium (Snowy)", "Throwback Stadium", "Urban Central (Dawn)",
-        "Urban Central (Night)", "Urban Central", "Urban Central (Spooky)", "AquaDome (Salty Shallows)", "Aquadome",
+        "Beckwith Park", "Beckwith Park (Stormy)", "Beckwith Park (Snowy)", "Core 707",
+        "DFH Stadium (10th Anniversary)", "DFH Stadium (Day)", "DFH Stadium (Stormy)", "DFH Stadium",
+        "DFH Stadium (Circuit)", "DFH Stadium (Snowy)", "Sovereign Heights (Dusk)", "Champions Field (Nike FC)",
+        "Throwback Stadium (Snowy)", "Throwback Stadium", "Urban Central (Dawn)", "Urban Central (Night)",
+        "Urban Central", "Urban Central (Spooky)", "Futura Garden", "AquaDome (Salty Shallows)", "Aquadome",
         "Utopia Coliseum (Dusk)", "Utopia Coliseum (Gilded)", "Utopia Coliseum", "Utopia Coliseum (Snowy)",
         "Wasteland (Pitched)", "Wasteland (Night)", "Wasteland (Standard, Night)", "Wasteland", "Wasteland (Standard)",
-        "Drift Woods (Night", "Drift Woods"
+        "Drift Woods (Night)", "Drift Woods"
     )
     CODE_TO_NAME = {code: name for code, name in zip(ALL, NAMES)}
     STANDARD_MAPS = (
-        ARC_DARC_P, ARC_STANDARD_P, BEACH_NIGHT_GRS_P, BEACH_NIGHT_P, CHN_STADIUM_DAY_P, CHN_STADIUM_P,
-        EUROSTADIUM_DUSK_P, EUROSTADIUM_NIGHT_P, EUROSTADIUM_RAINY_P, EUROSTADIUM_SNOWNIGHT_P, FARM_GRS_P, FARM_NIGHT_P,
-        FARM_P, FF_DUSK_P, FNI_STADIUM_P, LABS_PILLARGLASS_P, MUSIC_P, NEOTOKYO_ARCADE_P, NEOTOKYO_HAX_P,
-        NEOTOKYO_STANDARD_P, NEOTOKYO_TOON_P, OUTLAW_OASIS_P, OUTLAW_P, PARK_NIGHT_P, PARK_P, PARK_RAINY_P,
-        PARK_SNOWY_P, STADIUM_DAY_P, STADIUM_FOGGY_P, STADIUM_P, STADIUM_RACE_DAY_P, STADIUM_WINTER_P, STREET_P,
-        TRAINSTATION_DAWN_P, TRAINSTATION_NIGHT_P, TRAINSTATION_P, UNDERWATER_GRS_P, UNDERWATER_P, UTOPIASTADIUM_DUSK_P,
-        UTOPIASTADIUM_LUX_P, UTOPIASTADIUM_SNOW_P, UTOPIASTADIUM_P, WASTELAND_GRS_P, WASTELAND_NIGHT_P,
-        WASTELAND_NIGHT_S_P, WASTELAND_S_P, WOODS_NIGHT_P, WOODS_P
+        ARC_DARC_P, ARC_STANDARD_P, BEACH_NIGHT_GRS_P, BEACH_NIGHT_P, BEACH_P, CHN_STADIUM_DAY_P, CHN_STADIUM_P,
+        CS_DAY_P, CS_HW_P, CS_P, EUROSTADIUM_DUSK_P, EUROSTADIUM_NIGHT_P, EUROSTADIUM_P, EUROSTADIUM_RAINY_P,
+        EUROSTADIUM_SNOWNIGHT_P, FARM_GRS_P, FARM_NIGHT_P, FARM_P, FARM_UPSIDEDOWN_P, FF_DUSK_P, FNI_STADIUM_P, MUSIC_P,
+        NEOTOKYO_ARCADE_P, NEOTOKYO_HAX_P, NEOTOKYO_STANDARD_P, OUTLAW_OASIS_P, OUTLAW_P, PARK_NIGHT_P, PARK_P,
+        PARK_RAINY_P, PARK_SNOWY_P, STADIUM_10A_P, STADIUM_DAY_P, STADIUM_FOGGY_P, STADIUM_P, STADIUM_RACE_DAY_P,
+        STADIUM_WINTER_P, STREET_P, TRAINSTATION_DAWN_P, TRAINSTATION_NIGHT_P, TRAINSTATION_P, UF_DAY_P,
+        UNDERWATER_GRS_P, UNDERWATER_P, UTOPIASTADIUM_DUSK_P, UTOPIASTADIUM_LUX_P, UTOPIASTADIUM_P,
+        UTOPIASTADIUM_SNOW_P, WASTELAND_GRS_P, WASTELAND_NIGHT_P, WASTELAND_NIGHT_S_P, WASTELAND_P, WASTELAND_S_P,
+        WOODS_NIGHT_P, WOODS_P
     )
     NON_STANDARD_MAPS = (
-        ARC_P, BB_P, BEACH_P, BEACHVOLLEY, CS_DAY_P, CS_HW_P, CS_P, EUROSTADIUM_P, FARM_HW_P,
-        FARM_UPSIDEDOWN_P, HAUNTED_TRAINSTATION_P, HOOPSSTADIUM_P, HOOPSSTREET_P, LABS_CIRCLEPILLARS_P,
-        LABS_COSMIC_P, LABS_COSMIC_V4_P, LABS_DOUBLEGOAL_P, LABS_DOUBLEGOAL_V2_P, LABS_OCTAGON_02_P,
-        LABS_OCTAGON_P, LABS_UNDERPASS_P, LABS_UNDERPASS_V0_P, LABS_UTOPIA_P, NEOTOKYO_P, PARK_BMAN_P,
-        SHATTERSHOT_P, THROWBACKHOCKEY_P, THROWBACKSTADIUM_P, TRAINSTATION_SPOOKY_P, WASTELAND_P
+        ARC_P, BB_P, BEACHVOLLEY, FARM_HW_P, HAUNTED_TRAINSTATION_P, HOOPSSTADIUM_P, HOOPSSTREET_P, KO_CALAVERA_P,
+        KO_CARBON_P, KO_QUADRON_P, LABS_BASIN_P, LABS_CIRCLEPILLARS_P, LABS_CORRIDOR_P, LABS_COSMIC_P, LABS_COSMIC_V4_P,
+        LABS_DOUBLEGOAL_P, LABS_DOUBLEGOAL_V2_P, LABS_GALLEON_MAST_P, LABS_GALLEON_P, LABS_HOLYFIELD_P,
+        LABS_HOLYFIELD_SPACE_P, LABS_OCTAGON_02_P, LABS_OCTAGON_P, LABS_PILLARGLASS_P, LABS_PILLARHEAT_P,
+        LABS_PILLARWINGS_P, LABS_UNDERPASS_P, LABS_UNDERPASS_V0_P, LABS_UTOPIA_P, NEOTOKYO_P, NEOTOKYO_TOON_P,
+        PARK_BMAN_P, SHATTERSHOT_P, SWOOSH_P, THROWBACKHOCKEY_P, THROWBACKSTADIUM_P, TRAINSTATION_SPOOKY_P
     )

{python_ballchasing-0.2.0 → python_ballchasing-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-ballchasing"
-version = "0.2.0"
+version = "0.3.0"
 authors = [
     { name = "Rolv-Arild Braaten", email = "rolv_arild@hotmail.com" },
 ]

python_ballchasing-0.3.0/python_ballchasing.egg-info/PKG-INFO

@@ -0,0 +1,92 @@
+Metadata-Version: 2.4
+Name: python-ballchasing
+Version: 0.3.0
+Summary: A Python wrapper around the Ballchasing API
+Author-email: Rolv-Arild Braaten <rolv_arild@hotmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/Rolv-Arild/python-ballchasing
+Project-URL: Download, https://pypi.python.org/pypi/python-ballchasing
+Classifier: Programming Language :: Python :: 3.8
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Dynamic: license-file
+
+# Python Ballchasing
+An easy-to-use and comprehensive Python wrapper for the [ballchasing.com API](https://ballchasing.com/doc/api).
+
+## Installation
+You can install the library from PyPI using pip:
+```
+pip install python-ballchasing
+```
+
+## Authentication
+Before you can use the library, you need an API authentication key from ballchasing.com.
+1. Log in to [ballchasing.com](https://ballchasing.com/).
+2. Navigate to the Upload tab.
+3. Create an API key and copy it.
+   
+**Keep your API key secure and do not share it publicly.**
+
+## API
+For detailed information, please refer to the docs inside the code. For the most part it follows the API spec closely, but there are some differences.
+
+The API is exposed via the `BallchasingApi` class.
+
+Making the client:
+```python
+from ballchasing import BallchasingApi
+api = BallchasingApi("Your token here")
+```
+or equivalently
+```python
+import ballchasing
+api = ballchasing.Api("Your token here")
+```
+By default this will also ping the API to make sure it's working.
+
+---
+Some simple examples:
+```python
+# Get lots of SSL replays
+
+from ballchasing import Rank  # there's also Playlist, Season, Map, and more
+
+replays = api.get_replays(
+  min_rank=Rank.SUPERSONIC_LEGEND,
+  count=10_000  # The API limits you to 200 replays per request but the library handles this for you
+)
+
+for replay in replays:  # (replays is an iterable so you don't need to wait for all the replays to be collected)
+  ...  # Do something with the replays
+```
+
+```python
+# Get a specific replay with more detail than the iterator (including stats!)
+replay = api.get_replay("2627e02a-aa46-4e13-b66b-b76a32069a07")
+```
+
+```python
+# Get groups by the "RLCS Referee" account
+groups = api.get_groups(creator="76561199225615730")
+
+for group in groups:
+  # Download the group
+  api.download_group(
+    group_id=group["id"],
+    folder="/path/to/destination/"
+    recursive=True,  # To download all the replays and retain the group structure with subfolders
+  )
+
+  # Get replays from the group
+  replays = get_group_replays(
+    group_id=group["id"],
+    deep=True,  # To get detailed replay info
+  )
+  for replay in replays:
+    api.download_replay(replay_id=replay["id"], folder="/path/to/destination/")  # You could also download like this
+```

python_ballchasing-0.2.0/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: python-ballchasing
-Version: 0.2.0
-Summary: A Python wrapper around the Ballchasing API
-Author-email: Rolv-Arild Braaten <rolv_arild@hotmail.com>
-License: MIT License
-Project-URL: Homepage, https://github.com/Rolv-Arild/python-ballchasing
-Project-URL: Download, https://pypi.python.org/pypi/python-ballchasing
-Classifier: Programming Language :: Python :: 3.8
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-Dynamic: license-file
-
-# Python Ballchasing
-Python wrapper for the ballchasing.com API. 
-
-# Installation
-```
-pip install python-ballchasing
-```
-
-# API
-The API is exposed via the `ballchasing.Api` class.
-
-Simple example:
-```python
-import ballchasing
-api = ballchasing.Api("Your token here")
-
-# Get a specific replay
-replay = api.get_replay("2627e02a-aa46-4e13-b66b-b76a32069a07")
-```

python_ballchasing-0.2.0/README.md

@@ -1,19 +0,0 @@
-# Python Ballchasing
-Python wrapper for the ballchasing.com API. 
-
-# Installation
-```
-pip install python-ballchasing
-```
-
-# API
-The API is exposed via the `ballchasing.Api` class.
-
-Simple example:
-```python
-import ballchasing
-api = ballchasing.Api("Your token here")
-
-# Get a specific replay
-replay = api.get_replay("2627e02a-aa46-4e13-b66b-b76a32069a07")
-```

python_ballchasing-0.2.0/python_ballchasing.egg-info/PKG-INFO

@@ -1,36 +0,0 @@
-Metadata-Version: 2.4
-Name: python-ballchasing
-Version: 0.2.0
-Summary: A Python wrapper around the Ballchasing API
-Author-email: Rolv-Arild Braaten <rolv_arild@hotmail.com>
-License: MIT License
-Project-URL: Homepage, https://github.com/Rolv-Arild/python-ballchasing
-Project-URL: Download, https://pypi.python.org/pypi/python-ballchasing
-Classifier: Programming Language :: Python :: 3.8
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: requests
-Dynamic: license-file
-
-# Python Ballchasing
-Python wrapper for the ballchasing.com API. 
-
-# Installation
-```
-pip install python-ballchasing
-```
-
-# API
-The API is exposed via the `ballchasing.Api` class.
-
-Simple example:
-```python
-import ballchasing
-api = ballchasing.Api("Your token here")
-
-# Get a specific replay
-replay = api.get_replay("2627e02a-aa46-4e13-b66b-b76a32069a07")
-```