lpdb_python 0.1.2__tar.gz → 0.2.0__tar.gz

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/.github/workflows/ci.yml

@@ -51,9 +51,7 @@ jobs:
     steps:
       - name: Checkout repository
         uses: actions/checkout@v6
-      - name: Setup Python
-        uses: actions/setup-python@v6
-        with:
-          python-version-file: "pyproject.toml"
+      - name: Run linter
+        uses: astral-sh/ruff-action@v3
       - name: Check styling
-        uses: psf/black@stable
+        run: ruff format --check --diff

lpdb_python-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,74 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      # Publish on any tag starting with a `v`, e.g., v0.1.0
+      - v*
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish
+
+  # Build the documentation and upload the static HTML files as an artifact.
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Setup Python
+        uses: actions/setup-python@v6
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+
+      - name: Setup project
+        run: uv sync --all-extras --dev
+
+      - name: Build docs
+        run: uv run pdoc lpdb_python.defs lpdb_python.session lpdb_python.async_session -t docs/ -o output/docs/
+        env:
+          VERSION: ${{ github.ref_name }}
+
+      - uses: actions/upload-pages-artifact@v4
+        with:
+          path: output/docs/
+
+  deploy:
+    needs: build-docs
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy
+        id: deployment
+        uses: actions/deploy-pages@v4

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lpdb_python
-Version: 0.1.2
+Version: 0.2.0
 Author-email: ElectricalBoy <electricalboy01@gmail.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/ElectricalBoy/LPDB_python
@@ -25,7 +25,21 @@ Dynamic: license-file
 
 LPDB_python provides Python interfaces for the [Liquipedia Database API](https://liquipedia.net/api) (LPDB API).
 
-## LPDB Session
+## What You Need
+
+- Python 3.12 or later
+- API key for LPDB
+- (Optional) [aiohttp](https://github.com/aio-libs/aiohttp)
+
+## Installation
+
+```bash
+pip install lpdb_python
+```
+
+## Basic Uses
+
+### LPDB Session
 
 Python wrapper for LPDB session is defined in [session.py](src/lpdb_python/session.py). The wrapper provides the following
 differences from making your own requests:
@@ -45,7 +59,16 @@ differences from making your own requests:
   session = lpdb.LpdbSession("Apikey your_lpdb_api_key")
   ```
 
-## LPDB Data Types
+#### Async Session
+
+Asynchronous implementation of LPDB session can be found in [async_session/session.py](src/lpdb_python/async_session/async_session.py).
+This implementation depends on [aiohttp](https://github.com/aio-libs/aiohttp), which can be installed with this library with the following command:
+
+```bash
+pip install lpdb_python[async]
+```
+
+### LPDB Data Types
 
 Data types in LPDB can be found in <https://liquipedia.net/commons/Help:LiquipediaDB>.
 
@@ -57,7 +80,7 @@ A property provided by the wrapper may be `None` if the raw data passed to the c
 did not contain the data, or if it contained an empty string. Thus, the user should be checking for `None`
 where appropriate.
 
-### Example
+#### Example
 
 ```python
 import lpdb_python as lpdb

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/README.md

@@ -7,7 +7,21 @@
 
 LPDB_python provides Python interfaces for the [Liquipedia Database API](https://liquipedia.net/api) (LPDB API).
 
-## LPDB Session
+## What You Need
+
+- Python 3.12 or later
+- API key for LPDB
+- (Optional) [aiohttp](https://github.com/aio-libs/aiohttp)
+
+## Installation
+
+```bash
+pip install lpdb_python
+```
+
+## Basic Uses
+
+### LPDB Session
 
 Python wrapper for LPDB session is defined in [session.py](src/lpdb_python/session.py). The wrapper provides the following
 differences from making your own requests:
@@ -27,7 +41,16 @@ differences from making your own requests:
   session = lpdb.LpdbSession("Apikey your_lpdb_api_key")
   ```
 
-## LPDB Data Types
+#### Async Session
+
+Asynchronous implementation of LPDB session can be found in [async_session/session.py](src/lpdb_python/async_session/async_session.py).
+This implementation depends on [aiohttp](https://github.com/aio-libs/aiohttp), which can be installed with this library with the following command:
+
+```bash
+pip install lpdb_python[async]
+```
+
+### LPDB Data Types
 
 Data types in LPDB can be found in <https://liquipedia.net/commons/Help:LiquipediaDB>.
 
@@ -39,7 +62,7 @@ A property provided by the wrapper may be `None` if the raw data passed to the c
 did not contain the data, or if it contained an empty string. Thus, the user should be checking for `None`
 where appropriate.
 
-### Example
+#### Example
 
 ```python
 import lpdb_python as lpdb

lpdb_python-0.2.0/docs/module.html.jinja2

@@ -0,0 +1,9 @@
+{% extends "default/module.html.jinja2" %}
+
+{% block nav_footer %}
+    <footer>
+        lpdb_python {{ env["VERSION"] | default("0.0.0") }}
+        <br />
+        <a href="https://github.com/ElectricalBoy/LPDB_python"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/ElectricalBoy/lpdb_python" /></a>
+    </footer>
+{% endblock %}

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/pyproject.toml

@@ -32,7 +32,8 @@ async = [
 [dependency-groups]
 dev = [
     {include-group = "test"},
-    {include-group = "lint"}
+    {include-group = "lint"},
+    {include-group = "docs"}
 ]
 test = [
     "pytest",
@@ -41,8 +42,14 @@ test = [
 lint = [
     "black",
 ]
+docs = [
+    "pdoc",
+]
 
 [tool.pytest.ini_options]
 pythonpath = [
     "src"
 ]
+
+[tool.ruff]
+target-version = "py312"

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/src/lpdb_python/__init__.py

@@ -4,8 +4,27 @@ Python interface for Liquipedia Database (LPDB) API
 
 import importlib.metadata as _metadata
 
-from .defs import *
-from .session import *
+from .defs import (
+    OpponentType,
+    Broadcasters,
+    Company,
+    Datapoint,
+    ExternalMediaLink,
+    Match,
+    MatchGame,
+    MatchOpponent,
+    Placement,
+    Player,
+    Series,
+    SquadPlayer,
+    StandingsEntry,
+    StandingsTable,
+    Team,
+    Tournament,
+    Transfer,
+    TeamTemplate,
+)
+from .session import LpdbError, LpdbWarning, LpdbSession
 
 __all__ = [
     "OpponentType",

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/src/lpdb_python/async_session/async_session.py

@@ -4,7 +4,7 @@ from typing import Any, Literal, Optional, override
 
 import aiohttp
 
-from ..session import AbstractLpdbSession, LpdbDataType, LpdbError
+from ..session import AbstractLpdbSession, LpdbDataType
 
 __all__ = ["AsyncLpdbSession"]
 
@@ -112,11 +112,11 @@ class AsyncLpdbSession(AbstractLpdbSession):
             "wiki": wiki,
             "template": template,
         }
-        if date != None:
+        if date is not None:
             params["date"] = date.isoformat()
         async with self.__session.get("teamtemplate", params=params) as response:
             parsed_response = await AsyncLpdbSession.__handle_response(response)
-            if parsed_response[0] == None:
+            if parsed_response[0] is None:
                 return None
             return parsed_response[0]
 

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/src/lpdb_python/defs.py

@@ -119,7 +119,6 @@ class LpdbBaseResponseData(LpdbBaseData):
 
 
 class Broadcasters(LpdbBaseResponseData):
-
     @property
     def id(self) -> str:
         return self._rawGet("id")
@@ -158,7 +157,6 @@ class Broadcasters(LpdbBaseResponseData):
 
 
 class Company(LpdbBaseResponseData):
-
     @property
     def name(self) -> str:
         return self._rawGet("name")
@@ -213,7 +211,6 @@ class Company(LpdbBaseResponseData):
 
 
 class Datapoint(LpdbBaseResponseData):
-
     @property
     def type(self) -> str:
         return self._rawGet("type")
@@ -244,7 +241,6 @@ class Datapoint(LpdbBaseResponseData):
 
 
 class ExternalMediaLink(LpdbBaseResponseData):
-
     @property
     def title(self) -> str:
         return self._rawGet("title")
@@ -279,7 +275,6 @@ class ExternalMediaLink(LpdbBaseResponseData):
 
 
 class Match(LpdbBaseResponseData):
-
     @property
     def match2id(self) -> str:
         return self._rawGet("match2id")
@@ -341,7 +336,7 @@ class Match(LpdbBaseResponseData):
         parsed = _parseIsoDateTime(self._rawGet("date"))
         if not self.dateexact:
             return parsed
-        elif self.timezone != None:
+        elif self.timezone is not None:
             return parsed.astimezone(tz=self.timezone)
         return parsed
 
@@ -356,10 +351,10 @@ class Match(LpdbBaseResponseData):
         """
         if not self.dateexact:
             return None
-        elif self.extradata == None:
+        elif self.extradata is None:
             return None
         offset: str = self.extradata.get("timezoneoffset")
-        if offset == None:
+        if offset is None:
             return None
         sliced_offset = offset.split(":")
         offset_delta = timedelta(
@@ -427,10 +422,6 @@ class Match(LpdbBaseResponseData):
     def match2bracketdata(self) -> dict:
         return self._rawGet("match2bracketdata")
 
-    @property
-    def tickername(self) -> str:
-        return self._rawGet("tickername")
-
     @property
     def match2games(self) -> list["MatchGame"]:
         return [
@@ -529,7 +520,6 @@ class MatchGame(LpdbBaseData):
 
 
 class MatchOpponent(LpdbBaseData):
-
     @property
     def id(self) -> int:
         return self._rawGet("id")
@@ -566,13 +556,9 @@ class MatchOpponent(LpdbBaseData):
     def match2players(self) -> list[dict]:
         return self._rawGet("match2players")
 
-    @property
-    def extradata(self) -> dict:
-        return self._rawGet("extradata")
-
     @property
     def teamtemplate(self) -> Optional["TeamTemplate"]:
-        if self.template == None:
+        if self.template is None:
             return None
         return TeamTemplate(self._rawGet("teamtemplate"))
 
@@ -582,7 +568,6 @@ class MatchOpponent(LpdbBaseData):
 
 
 class Placement(LpdbBaseResponseData):
-
     @property
     def tournament(self) -> str:
         return self._rawGet("tournament")
@@ -693,7 +678,6 @@ class Placement(LpdbBaseResponseData):
 
 
 class Player(LpdbBaseResponseData):
-
     @property
     def id(self) -> str:
         return self._rawGet("id")
@@ -764,7 +748,6 @@ class Player(LpdbBaseResponseData):
 
 
 class Series(LpdbBaseResponseData):
-
     @property
     def name(self) -> str:
         return self._rawGet("name")
@@ -855,7 +838,6 @@ class Series(LpdbBaseResponseData):
 
 
 class SquadPlayer(LpdbBaseResponseData):
-
     @property
     def id(self) -> str:
         return self._rawGet("id")
@@ -926,7 +908,6 @@ class SquadPlayer(LpdbBaseResponseData):
 
 
 class StandingsEntry(LpdbBaseResponseData):
-
     @property
     def parent(self) -> str:
         return self._rawGet("parent")
@@ -981,7 +962,6 @@ class StandingsEntry(LpdbBaseResponseData):
 
 
 class StandingsTable(LpdbBaseResponseData):
-
     @property
     def parent(self) -> str:
         return self._rawGet("parent")
@@ -1016,7 +996,6 @@ class StandingsTable(LpdbBaseResponseData):
 
 
 class Team(LpdbBaseResponseData):
-
     @property
     def name(self) -> str:
         return self._rawGet("name")
@@ -1083,7 +1062,6 @@ class Team(LpdbBaseResponseData):
 
 
 class Tournament(LpdbBaseResponseData):
-
     @property
     def name(self) -> str:
         return self._rawGet("name")
@@ -1219,7 +1197,7 @@ class Tournament(LpdbBaseResponseData):
     @property
     def maps(self) -> list[str]:
         map_data: Optional[str] = self._rawGet("maps")
-        if map_data == None:
+        if map_data is None:
             return None
         return map_data.split(";")
 
@@ -1233,7 +1211,6 @@ class Tournament(LpdbBaseResponseData):
 
 
 class Transfer(LpdbBaseResponseData):
-
     @property
     def player(self) -> str:
         return self._rawGet("player")
@@ -1280,7 +1257,6 @@ class Transfer(LpdbBaseResponseData):
 
 
 class TeamTemplate(LpdbBaseData):
-
     @property
     def template(self) -> str:
         return self._rawGet("template")

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/src/lpdb_python/session.py

@@ -15,11 +15,23 @@ from typing import (
 )
 import re
 import warnings
+import importlib.metadata as metadata
 
 import requests
 
 __all__ = ["LpdbDataType", "LpdbError", "LpdbWarning", "LpdbSession"]
 
+_PACKAGE_NAME: Final[str] = "lpdb_python"
+
+
+@cache
+def _get_version() -> str:
+    try:
+        return metadata.version(_PACKAGE_NAME)
+    except metadata.PackageNotFoundError:
+        return "dev"
+
+
 type LpdbDataType = Literal[
     "broadcasters",
     "company",
@@ -122,6 +134,7 @@ class AbstractLpdbSession(ABC):
             "authorization": f"Apikey {self.__api_key}",
             "accept": "application/json",
             "accept-encoding": "gzip",
+            "user-agent": f"{_PACKAGE_NAME}/{_get_version()}",
         }
 
     @staticmethod
@@ -162,7 +175,7 @@ class AbstractLpdbSession(ABC):
         :param order: the order of results to be sorted in; each ordering rule is specified as a `(datapoint, direction)` tuple
         :param groupby: the way that the query results are grouped; each grouping rule is specified as a `(datapoint, direction)` tuple
 
-        :returns: result of the query
+        :return: result of the query
 
         :raises ValueError: if an invalid `lpdb_datatype` is supplied
         :raises LpdbError: if something went wrong with the request
@@ -182,7 +195,7 @@ class AbstractLpdbSession(ABC):
         :param wiki: the wiki to query
         :param conditions: the conditions for the query
 
-        :returns: number of objects that satisfy the condition(s)
+        :return: number of objects that satisfy the condition(s)
 
         :raises ValueError: if an invalid `lpdb_datatype` is supplied
         :raises LpdbError: if something went wrong with the request
@@ -206,7 +219,7 @@ class AbstractLpdbSession(ABC):
         :param template: the name of team template
         :param date: the contextual date for the requested team template
 
-        :returns: the requested team template, may return `None` if the requested team template does not exist
+        :return: the requested team template, may return `None` if the requested team template does not exist
 
         :raises LpdbError: if something went wrong with the request
         """
@@ -224,7 +237,7 @@ class AbstractLpdbSession(ABC):
         :param wiki: the wiki to query
         :param pagination: used for pagination
 
-        :returns: team templates
+        :return: team templates
 
         :raises LpdbError: if something went wrong with the request
         """
@@ -250,21 +263,21 @@ class AbstractLpdbSession(ABC):
             raise TypeError()
         parameters["limit"] = min(limit, 1000)
         parameters["offset"] = offset
-        if conditions != None:
+        if conditions is not None:
             parameters["conditions"] = conditions
-        if query != None:
+        if query is not None:
             if isinstance(query, str):
                 parameters["query"] = query
             else:
                 parameters["query"] = ", ".join(query)
-        if order != None:
+        if order is not None:
             if isinstance(order, str):
                 parameters["order"] = order
             else:
                 parameters["order"] = ", ".join(
                     [f"{order_tuple[0]} {order_tuple[1]}" for order_tuple in order]
                 )
-        if groupby != None:
+        if groupby is not None:
             if isinstance(groupby, str):
                 parameters["groupby"] = groupby
             else:
@@ -361,7 +374,7 @@ class LpdbSession(AbstractLpdbSession):
             "wiki": wiki,
             "template": template,
         }
-        if date != None:
+        if date is not None:
             params["date"] = date.isoformat()
         lpdb_response = requests.get(
             self._base_url + "teamtemplate",

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/src/lpdb_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lpdb_python
-Version: 0.1.2
+Version: 0.2.0
 Author-email: ElectricalBoy <electricalboy01@gmail.com>
 License-Expression: MIT
 Project-URL: Homepage, https://github.com/ElectricalBoy/LPDB_python
@@ -25,7 +25,21 @@ Dynamic: license-file
 
 LPDB_python provides Python interfaces for the [Liquipedia Database API](https://liquipedia.net/api) (LPDB API).
 
-## LPDB Session
+## What You Need
+
+- Python 3.12 or later
+- API key for LPDB
+- (Optional) [aiohttp](https://github.com/aio-libs/aiohttp)
+
+## Installation
+
+```bash
+pip install lpdb_python
+```
+
+## Basic Uses
+
+### LPDB Session
 
 Python wrapper for LPDB session is defined in [session.py](src/lpdb_python/session.py). The wrapper provides the following
 differences from making your own requests:
@@ -45,7 +59,16 @@ differences from making your own requests:
   session = lpdb.LpdbSession("Apikey your_lpdb_api_key")
   ```
 
-## LPDB Data Types
+#### Async Session
+
+Asynchronous implementation of LPDB session can be found in [async_session/session.py](src/lpdb_python/async_session/async_session.py).
+This implementation depends on [aiohttp](https://github.com/aio-libs/aiohttp), which can be installed with this library with the following command:
+
+```bash
+pip install lpdb_python[async]
+```
+
+### LPDB Data Types
 
 Data types in LPDB can be found in <https://liquipedia.net/commons/Help:LiquipediaDB>.
 
@@ -57,7 +80,7 @@ A property provided by the wrapper may be `None` if the raw data passed to the c
 did not contain the data, or if it contained an empty string. Thus, the user should be checking for `None`
 where appropriate.
 
-### Example
+#### Example
 
 ```python
 import lpdb_python as lpdb

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/src/lpdb_python.egg-info/SOURCES.txt

@@ -4,6 +4,7 @@ README.md
 pyproject.toml
 .github/workflows/ci.yml
 .github/workflows/publish.yml
+docs/module.html.jinja2
 src/lpdb_python/__init__.py
 src/lpdb_python/defs.py
 src/lpdb_python/session.py

{lpdb_python-0.1.2 → lpdb_python-0.2.0}/tests/test_data_wrapper.py

@@ -27,7 +27,7 @@ def test_read_match_data(match_data: lpdb.Match):
 
     assert match_data.liquipediatier == "1"
 
-    assert match_data.liquipediatiertype == None
+    assert match_data.liquipediatiertype is None
 
     assert match_data.finished
 

lpdb_python-0.1.2/.github/workflows/publish.yml

@@ -1,33 +0,0 @@
-name: Publish
-
-on:
-  push:
-    tags:
-      # Publish on any tag starting with a `v`, e.g., v0.1.0
-      - v*
-
-jobs:
-  run:
-    runs-on: ubuntu-latest
-    environment:
-      name: pypi
-    permissions:
-      id-token: write
-      contents: read
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-
-      - name: Setup Python
-        uses: actions/setup-python@v6
-        with:
-          python-version-file: "pyproject.toml"
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v7
-
-      - name: Build
-        run: uv build
-
-      - name: Publish
-        run: uv publish