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

{python-ballchasing-0.1.22 → python_ballchasing-0.3.0}/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Rolv-Arild Braaten
-
-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) 2020 Rolv-Arild Braaten
+
+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.

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.1.22 → python_ballchasing-0.3.0}/ballchasing/__init__.py

@@ -1,49 +1,67 @@
-#!/usr/bin/env python
-# MIT License
-#
-# Copyright (c) 2020 Rolv-Arild Braaten
-#
-# 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.
-
-"""A library that provides a Python interface to the Ballchasing API."""
-from __future__ import absolute_import
-
-__author__       = 'Rolv-Arild Braaten'
-__email__        = 'rolv_arild@hotmail.com'
-__copyright__    = 'Copyright (c) 2020 Rolv-Arild Braaten'
-__license__      = 'Apache License 2.0'
-__version__      = '0.1.22'
-__url__          = 'https://github.com/Rolv-Arild/python-ballchasing'
-__download_url__ = 'https://pypi.python.org/pypi/python-ballchasing'
-__description__  = 'A Python wrapper around the Ballchasing API'
-
-from .api import Api                        # noqa
-from .constants import (                    # noqa
-    Playlist,
-    Rank,
-    Season,
-    MatchResult,
-    ReplaySortBy,
-    GroupSortBy,
-    SortDir,
-    Visibility,
-    PlayerIdentification,
-    TeamIdentification,
-    Map
-)
+#!/usr/bin/env python
+# MIT License
+#
+# Copyright (c) 2020 Rolv-Arild Braaten
+#
+# 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.
+
+"""A library that provides a Python interface to the Ballchasing API."""
+import sys
+
+# In Python 3.8+, importlib.metadata is in the standard library.
+# For older versions, a backport is available as importlib_metadata.
+if sys.version_info >= (3, 8):
+    from importlib.metadata import version, metadata
+else:
+    from importlib_metadata import version, metadata
+
+try:
+    # This will read the version from the installed package's metadata
+    # (which is defined in pyproject.toml)
+    __version__ = version("python-ballchasing")
+
+    # You can also get other metadata in a similar way
+    pkg_metadata = metadata("python-ballchasing")
+    __author__ = pkg_metadata.get("Author-Email")
+    __description__ = pkg_metadata.get("Summary")
+except Exception:
+    # If the package is not installed (e.g., when running in a development
+    # environment without an editable install), you can fall back to defaults.
+    __version__ = "0.0.0-dev"
+    __description__ = 'A Python wrapper around the Ballchasing API'
+    __author__ = 'Rolv-Arild Braaten <rolv_arild@hotmail.com>'
+
+# Import the main classes and constants to make them easily accessible to users.
+from .api import BallchasingApi
+
+Api = BallchasingApi  # For importing like `import ballchasing; api = ballchasing.Api`
+
+from .constants import (
+    Playlist,
+    Rank,
+    Season,
+    MatchResult,
+    ReplaySortBy,
+    GroupSortBy,
+    SortDir,
+    Visibility,
+    PlayerIdentification,
+    TeamIdentification,
+    Map
+)