Add support for CollectionsLogged (#79)

* Add support for CollectionsLogged

Bump version to 2.0

Remove support for py3.8

Upgrade dependencies

* Lint - upgrade CI to use py3.13

Author: Jonxslays

.github/workflows/ci.yml

@@ -13,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
 
     steps:
@@ -56,13 +56,13 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
-      - name: Install python 3.8
+      - name: Install python 3.13
         uses: actions/setup-python@v3
         with:
-          python-version: "3.8"
+          python-version: "3.13"
 
       - name: Install poetry
-        uses: Gr1N/setup-poetry@v8
+        uses: Gr1N/setup-poetry@v9
 
       - name: Lint and format
         run: |

.github/workflows/dev-docs.yml

@@ -22,7 +22,7 @@ jobs:
           python-version: "3.10"
 
       - name: Install poetry
-        uses: Gr1N/setup-poetry@v8
+        uses: Gr1N/setup-poetry@v9
 
       - name: Install dependencies
         run: |

.github/workflows/release.yml

@@ -57,7 +57,7 @@ jobs:
           python-version: "3.10"
 
       - name: Install poetry
-        uses: Gr1N/setup-poetry@v8
+        uses: Gr1N/setup-poetry@v9
 
       - name: Install dependencies
         run: |

CHANGELOG.md

@@ -1,3 +1,17 @@
+# v2.0 (Jan 2025)
+
+# Breaking
+
+- Drop support for Python 3.8.
+- Minimum msgspec version is now `0.19.0`.
+
+## Additions
+
+- Add `CollectionsLogged` metric.
+- Add support for Python 3.13.
+
+---
+
 # v1.0.1 (Sep 2024)
 
 ## Additions

docs/getting-started/installation.md

@@ -1,6 +1,6 @@
 # Installation
 
-Python version 3.8 or greater is required to use wom.py.
+Python version 3.9 or greater is required to use wom.py.
 
 ## Stable
 

docs/migrating/v2.md

@@ -0,0 +1,8 @@
+# Migrating to V2
+
+When upgrading from `v1` to `v2.*` the only breaking change to take
+into account is that support for Python 3.8 has been dropped.
+
+Additionally the minimum required version of the msgspec dependency
+is now 0.19.0 - which may be breaking for some users on a lower version.
+This change was made to support Python 3.13.

mkdocs.yml

@@ -102,3 +102,4 @@ nav:
       - "getting-started/result.md"
   - "Migration guides":
       - "migrating/v1.md"
+      - "migrating/v2.md"

noxfile.py

@@ -68,10 +68,15 @@ def wrapper(session: nox.Session) -> None:
     return inner
 
 
+def run(session: nox.Session, *args: str) -> None:
+    session.run(*args, external=True)
+
+
 @nox.session(reuse_venv=True)
 @install("pytest", "pytest-asyncio", "pytest-testdox", "coverage", "aiohttp", "msgspec")
 def tests(session: nox.Session) -> None:
-    session.run(
+    run(
+        session,
         "coverage",
         "run",
         "--omit",
@@ -89,28 +94,28 @@ def coverage(session: nox.Session) -> None:
     if not Path(".coverage").exists():
         session.skip("Skipping coverage")
 
-    session.run("coverage", "report", "-m")
+    run(session, "coverage", "report", "-m")
 
 
 @nox.session(reuse_venv=True)
 @install("pyright", "mypy", "aiohttp", "msgspec")
 def types(session: nox.Session) -> None:
-    session.run("mypy")
-    session.run("pyright")
+    run(session, "mypy")
+    run(session, "pyright")
 
 
 @nox.session(reuse_venv=True)
-@install("black", "len8")
+@install("black")
 def formatting(session: nox.Session) -> None:
-    session.run("black", ".", "--check")
-    session.run("len8")
+    run(session, "black", ".", "--check")
 
 
 @nox.session(reuse_venv=True)
 @install("flake8", "isort")
 def imports(session: nox.Session) -> None:
-    session.run("isort", "wom", "tests", "-cq")
-    session.run(
+    run(session, "isort", "wom", "tests", "-cq")
+    run(
+        session,
         "flake8",
         "wom",
         "tests",
@@ -150,4 +155,4 @@ def licensing(session: nox.Session) -> None:
 @nox.session(reuse_venv=True)
 def alls(session: nox.Session) -> None:
     session.install(".")
-    session.run("python", "scripts/alls.py")
+    run(session, "python", "scripts/alls.py")

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "wom.py"
-version = "1.0.1"
+version = "2.0.0"
 description = "An asynchronous wrapper for the Wise Old Man API."
 authors = ["Jonxslays"]
 license = "MIT"
@@ -30,26 +30,25 @@ classifiers = [
 wom = "wom.__main__:_main"
 
 [tool.poetry.dependencies]
-python = ">=3.8"
+python = ">=3.9"
 aiohttp = ">3.8.1"
-msgspec = ">=0.18.5"
+msgspec = ">=0.19.0"
 
 [tool.poetry.group.dev.dependencies]
-black = "==23.12.1"
-coverage = "==7.4.0"
-flake8 = { version = "==7.0.0", python = ">=3.8.1" }
+black = "==25.1.0"
+coverage = "==7.6.10"
+flake8 = "==7.1.1"
 griffe = "==0.47.0"
-isort = "==5.13.2"
-len8 = { version = "==0.7.3.post0", python = "<3.12" }
+isort = "==6.0.0"
 mike = "==2.0.0"
-mkdocs-include-markdown-plugin = { version = "==6.0.4", python = "<3.12" }
-mkdocs-material = "==9.5.3"
-mkdocstrings = { version = "==0.24.0", extras = ["python"] }
-mypy = "==1.8.0"
-nox = "==2023.4.22"
-pyright = "==1.1.344"
-pytest = "==7.4.4"
-pytest-asyncio = "==0.23.3"
+mkdocs-include-markdown-plugin = "==6.2.2"
+mkdocs-material = "==9.5.50"
+mkdocstrings = { version = "==0.27.0", extras = ["python"] }
+mypy = "==1.14.1"
+nox = "==2024.10.9 "
+pyright = "==1.1.393"
+pytest = "==8.3.4"
+pytest-asyncio = "==0.25.3"
 pytest-testdox = "==3.1.0"
 
 [tool.black]
@@ -59,12 +58,6 @@ line-length = 99
 profile = "black"
 force_single_line = true
 
-[tool.len8]
-include = ["noxfile.py", "tests", "wom"]
-code-length = 99
-docs-length = 80
-strict = true
-
 [tool.mypy]
 packages = ["wom"]
 strict = true

wom/__init__.py

@@ -32,7 +32,7 @@
 from typing import Final
 
 __packagename__: Final[str] = "wom.py"
-__version__: Final[str] = "1.0.1"
+__version__: Final[str] = "2.0.0"
 __author__: Final[str] = "Jonxslays"
 __copyright__: Final[str] = "2023-present Jonxslays"
 __description__: Final[str] = "An asynchronous wrapper for the Wise Old Man API."

wom/client.py

@@ -170,7 +170,9 @@ def records(self) -> services.RecordService:
         return self._records
 
     def __init_service(self, service: t.Type[ServiceT]) -> ServiceT:
-        if not issubclass(service, services.BaseService):
+        if not issubclass(
+            service, services.BaseService
+        ):  # pyright: ignore[reportUnnecessaryIsInstance]
             raise TypeError(f"{service.__name__!r} can not be initialized as a service.")
 
         return service(self._http, self._serializer)

wom/enums.py

@@ -120,6 +120,7 @@ class Metric(BaseEnum):
     ClueScrollsHard = "clue_scrolls_hard"
     ClueScrollsElite = "clue_scrolls_elite"
     ClueScrollsMaster = "clue_scrolls_master"
+    CollectionsLogged = "collections_logged"
     ColosseumGlory = "colosseum_glory"
     LastManStanding = "last_man_standing"
     PvpArena = "pvp_arena"
@@ -242,6 +243,7 @@ class Metric(BaseEnum):
         Metric.ClueScrollsHard,
         Metric.ClueScrollsElite,
         Metric.ClueScrollsMaster,
+        Metric.CollectionsLogged,
         Metric.ColosseumGlory,
         Metric.LastManStanding,
         Metric.PvpArena,

wom/models/competitions/models.py

@@ -175,7 +175,7 @@ class CompetitionParticipationDetail(CompetitionParticipation):
     competitions."""
 
 
-class CompetitionDetail(Competition):
+class CompetitionDetail(Competition):  # type: ignore[override]
     """Represents competition details."""
 
     participations: t.List[CompetitionParticipationDetail] = []  # type: ignore[assignment]

wom/serializer.py

@@ -68,6 +68,8 @@ def get_decoder(self, model_type: t.Type[T]) -> Decoder[T]:
             The requested decoder.
         """
         if not (decoder := self._decoders.get(model_type)):
-            decoder = self._decoders[model_type] = Decoder(model_type)
+            decoder = self._decoders[model_type] = Decoder(  # pyright: ignore[reportArgumentType]
+                model_type
+            )
 
         return decoder  # type: ignore[return-value]

wom/services/http.py

@@ -109,7 +109,7 @@ def _get_request_func(self, method: str) -> t.Callable[..., t.Awaitable[t.Any]]:
         if not hasattr(self, "_method_mapping"):
             raise RuntimeError("HttpService.start was never called, aborting...")
 
-        return self._method_mapping[method]  # type: ignore[return-value]
+        return self._method_mapping[method]
 
     async def _init_session(self) -> None:
         self._session = aiohttp.ClientSession(