nyt-games 0.1.0__tar.gz

nyt_games-0.1.0/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 Joost Lekkerkerker
+
+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.

nyt_games-0.1.0/PKG-INFO

@@ -0,0 +1,161 @@
+Metadata-Version: 2.1
+Name: nyt_games
+Version: 0.1.0
+Summary: Asynchronous Python client for NYT games.
+Home-page: https://github.com/joostlek/python-nyt-games
+License: MIT
+Keywords: NYT games,api,async,client
+Author: Joost Lekkerkerker
+Author-email: joostlek@outlook.com
+Maintainer: Joost Lekkerkerker
+Maintainer-email: joostlek@outlook.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiohttp (>=3.0.0)
+Requires-Dist: mashumaro (>=3.11,<4.0)
+Requires-Dist: orjson (>=3.9.0)
+Requires-Dist: yarl (>=1.6.0)
+Project-URL: Bug Tracker, https://github.com/joostlek/python-nyt-games/issues
+Project-URL: Changelog, https://github.com/joostlek/python-nyt-games/releases
+Project-URL: Documentation, https://github.com/joostlek/python-nyt-games
+Project-URL: Repository, https://github.com/joostlek/python-nyt-games
+Description-Content-Type: text/markdown
+
+# Python: NYT Games
+
+[![GitHub Release][releases-shield]][releases]
+[![Python Versions][python-versions-shield]][pypi]
+![Project Stage][project-stage-shield]
+![Project Maintenance][maintenance-shield]
+[![License][license-shield]](LICENSE.md)
+
+[![Build Status][build-shield]][build]
+[![Code Coverage][codecov-shield]][codecov]
+
+Asynchronous Python client for NYT Games.
+
+## About
+
+This package allows you to fetch data from NYT Games.
+
+## Installation
+
+```bash
+pip install nyt_games
+```
+
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases]
+functionality. The format of the log is based on
+[Keep a Changelog][keepchangelog].
+
+Releases are based on [Semantic Versioning][semver], and use the format
+of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
+based on the following:
+
+- ``MAJOR``: Incompatible or major changes.
+- ``MINOR``: Backwards-compatible new features and enhancements.
+- ``PATCH``: Backwards-compatible bugfixes and package updates.
+
+## Contributing
+
+This is an active open-source project. We are always open to people who want to
+use the code or contribute to it.
+
+We've set up a separate document for our
+[contribution guidelines](.github/CONTRIBUTING.md).
+
+Thank you for being involved! :heart_eyes:
+
+## Setting up development environment
+
+This Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.
+
+You need at least:
+
+- Python 3.11+
+- [Poetry][poetry-install]
+- NodeJS 12+ (including NPM)
+
+To install all packages, including all development requirements:
+
+```bash
+npm install
+poetry install
+```
+
+As this repository uses the [pre-commit][pre-commit] framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```
+
+## Authors & contributors
+
+The content is by [Joost Lekkerkerker][joostlek].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2024 Joost Lekkerkerker
+
+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.
+
+[build-shield]: https://github.com/joostlek/python-nyt-games/actions/workflows/tests.yaml/badge.svg
+[build]: https://github.com/joostlek/python-nyt-games/actions
+[codecov-shield]: https://codecov.io/gh/joostlek/python-nyt-games/branch/master/graph/badge.svg
+[codecov]: https://codecov.io/gh/joostlek/python-nyt-games
+[commits-shield]: https://img.shields.io/github/commit-activity/y/joostlek/python-nyt-games.svg
+[commits]: https://github.com/joostlek/python-nyt-games/commits/master
+[contributors]: https://github.com/joostlek/python-nyt-games/graphs/contributors
+[joostlek]: https://github.com/joostlek
+[keepchangelog]: http://keepachangelog.com/en/1.0.0/
+[license-shield]: https://img.shields.io/github/license/joostlek/python-nyt-games.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
+[poetry-install]: https://python-poetry.org/docs/#installation
+[poetry]: https://python-poetry.org
+[pre-commit]: https://pre-commit.com/
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg
+[python-versions-shield]: https://img.shields.io/pypi/pyversions/nyt_games
+[releases-shield]: https://img.shields.io/github/release/joostlek/python-nyt-games.svg
+[releases]: https://github.com/joostlek/python-nyt-games/releases
+[semver]: http://semver.org/spec/v2.0.0.html
+[pypi]: https://pypi.org/project/nyt_games/
+

nyt_games-0.1.0/README.md

@@ -0,0 +1,129 @@
+# Python: NYT Games
+
+[![GitHub Release][releases-shield]][releases]
+[![Python Versions][python-versions-shield]][pypi]
+![Project Stage][project-stage-shield]
+![Project Maintenance][maintenance-shield]
+[![License][license-shield]](LICENSE.md)
+
+[![Build Status][build-shield]][build]
+[![Code Coverage][codecov-shield]][codecov]
+
+Asynchronous Python client for NYT Games.
+
+## About
+
+This package allows you to fetch data from NYT Games.
+
+## Installation
+
+```bash
+pip install nyt_games
+```
+
+## Changelog & Releases
+
+This repository keeps a change log using [GitHub's releases][releases]
+functionality. The format of the log is based on
+[Keep a Changelog][keepchangelog].
+
+Releases are based on [Semantic Versioning][semver], and use the format
+of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented
+based on the following:
+
+- ``MAJOR``: Incompatible or major changes.
+- ``MINOR``: Backwards-compatible new features and enhancements.
+- ``PATCH``: Backwards-compatible bugfixes and package updates.
+
+## Contributing
+
+This is an active open-source project. We are always open to people who want to
+use the code or contribute to it.
+
+We've set up a separate document for our
+[contribution guidelines](.github/CONTRIBUTING.md).
+
+Thank you for being involved! :heart_eyes:
+
+## Setting up development environment
+
+This Python project is fully managed using the [Poetry][poetry] dependency manager. But also relies on the use of NodeJS for certain checks during development.
+
+You need at least:
+
+- Python 3.11+
+- [Poetry][poetry-install]
+- NodeJS 12+ (including NPM)
+
+To install all packages, including all development requirements:
+
+```bash
+npm install
+poetry install
+```
+
+As this repository uses the [pre-commit][pre-commit] framework, all changes
+are linted and tested with each commit. You can run all checks and tests
+manually, using the following command:
+
+```bash
+poetry run pre-commit run --all-files
+```
+
+To run just the Python tests:
+
+```bash
+poetry run pytest
+```
+
+## Authors & contributors
+
+The content is by [Joost Lekkerkerker][joostlek].
+
+For a full list of all authors and contributors,
+check [the contributor's page][contributors].
+
+## License
+
+MIT License
+
+Copyright (c) 2024 Joost Lekkerkerker
+
+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.
+
+[build-shield]: https://github.com/joostlek/python-nyt-games/actions/workflows/tests.yaml/badge.svg
+[build]: https://github.com/joostlek/python-nyt-games/actions
+[codecov-shield]: https://codecov.io/gh/joostlek/python-nyt-games/branch/master/graph/badge.svg
+[codecov]: https://codecov.io/gh/joostlek/python-nyt-games
+[commits-shield]: https://img.shields.io/github/commit-activity/y/joostlek/python-nyt-games.svg
+[commits]: https://github.com/joostlek/python-nyt-games/commits/master
+[contributors]: https://github.com/joostlek/python-nyt-games/graphs/contributors
+[joostlek]: https://github.com/joostlek
+[keepchangelog]: http://keepachangelog.com/en/1.0.0/
+[license-shield]: https://img.shields.io/github/license/joostlek/python-nyt-games.svg
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2024.svg
+[poetry-install]: https://python-poetry.org/docs/#installation
+[poetry]: https://python-poetry.org
+[pre-commit]: https://pre-commit.com/
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-stable-green.svg
+[python-versions-shield]: https://img.shields.io/pypi/pyversions/nyt_games
+[releases-shield]: https://img.shields.io/github/release/joostlek/python-nyt-games.svg
+[releases]: https://github.com/joostlek/python-nyt-games/releases
+[semver]: http://semver.org/spec/v2.0.0.html
+[pypi]: https://pypi.org/project/nyt_games/

nyt_games-0.1.0/pyproject.toml

@@ -0,0 +1,162 @@
+[tool.poetry]
+name = "nyt_games"
+version = "0.1.0"
+description = "Asynchronous Python client for NYT games."
+authors = ["Joost Lekkerkerker <joostlek@outlook.com>"]
+maintainers = ["Joost Lekkerkerker <joostlek@outlook.com>"]
+license = "MIT"
+readme = "README.md"
+homepage = "https://github.com/joostlek/python-nyt-games"
+repository = "https://github.com/joostlek/python-nyt-games"
+documentation = "https://github.com/joostlek/python-nyt-games"
+keywords = ["NYT games", "api", "async", "client"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Framework :: AsyncIO",
+  "Intended Audience :: Developers",
+  "Natural Language :: English",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+packages = [
+    { include = "nyt_games", from = "src" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+aiohttp = ">=3.0.0"
+yarl = ">=1.6.0"
+mashumaro = "^3.11"
+orjson = ">=3.9.0"
+
+[tool.poetry.group.dev.dependencies]
+codespell = "2.3.0"
+covdefaults = "2.3.0"
+coverage = {version = "7.6.1", extras = ["toml"]}
+mypy = "1.11.2"
+pre-commit = "3.8.0"
+pre-commit-hooks = "4.6.0"
+pylint = "3.2.7"
+pytest = "8.3.3"
+pytest-asyncio = "0.24.0"
+pytest-cov = "5.0.0"
+ruff = "0.6.5"
+safety = "3.2.7"
+yamllint = "1.35.1"
+syrupy = "4.7.1"
+aioresponses = "0.7.6"
+
+[tool.poetry.urls]
+"Bug Tracker" = "https://github.com/joostlek/python-nyt-games/issues"
+Changelog = "https://github.com/joostlek/python-nyt-games/releases"
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["nyt_games"]
+
+[tool.mypy]
+# Specify the target platform details in config, so your developers are
+# free to run mypy on Windows, Linux, or macOS and get consistent
+# results.
+platform = "linux"
+python_version = "3.11"
+
+# show error messages from unrelated files
+follow_imports = "normal"
+
+# suppress errors about unsatisfied imports
+ignore_missing_imports = true
+
+# be strict
+check_untyped_defs = true
+disallow_any_generics = true
+disallow_incomplete_defs = true
+disallow_subclassing_any = true
+disallow_untyped_calls = true
+disallow_untyped_decorators = true
+disallow_untyped_defs = true
+no_implicit_optional = true
+strict_optional = true
+warn_incomplete_stub = true
+warn_no_return = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+warn_unused_ignores = true
+
+[tool.pylint.MASTER]
+ignore = [
+  "tests",
+]
+
+[tool.pylint.BASIC]
+good-names = [
+  "_",
+  "ex",
+  "fp",
+  "i",
+  "id",
+  "j",
+  "k",
+  "on",
+  "Run",
+  "T",
+]
+
+[tool.pylint.DESIGN]
+max-attributes = 8
+
+[tool.pylint."MESSAGES CONTROL"]
+disable = [
+  "duplicate-code",
+  "format",
+  "unsubscriptable-object",
+  "too-many-instance-attributes",
+  "wrong-import-order",
+]
+
+[tool.pylint.SIMILARITIES]
+ignore-imports = true
+
+[tool.pylint.FORMAT]
+max-line-length = 88
+
+[tool.pytest.ini_options]
+addopts = "--cov"
+asyncio_mode = "auto"
+
+[tool.ruff.lint]
+ignore = [
+  "ANN101", # Self... explanatory
+  "ANN102", # cls... just as useless
+  "ANN401", # Opinioated warning on disallowing dynamically typed expressions
+  "COM812", # Conflicts with other rules
+  "D203", # Conflicts with other rules
+  "D213", # Conflicts with other rules
+  "D417", # False positives in some occasions
+  "ISC001", # Conflicts with other rules
+  "PLR2004", # Just annoying, not really useful
+]
+select = ["ALL"]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+
+[tool.ruff.lint.isort]
+known-first-party = ["nyt_games"]
+force-sort-within-sections = true
+split-on-trailing-comma = false
+combine-as-imports = true
+
+[tool.ruff.lint.mccabe]
+max-complexity = 25
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core>=1.0.0"]

nyt_games-0.1.0/src/nyt_games/__init__.py

@@ -0,0 +1,18 @@
+"""Asynchronous Python client for NYT Games."""
+
+from nyt_games.exceptions import (
+    NYTGamesConnectionError,
+    NYTGamesError,
+    NYTGamesParseError,
+)
+from nyt_games.models import LatestDataStats, Wordle
+from nyt_games.nyt_games import NYTGamesClient
+
+__all__ = [
+    "NYTGamesClient",
+    "NYTGamesError",
+    "NYTGamesConnectionError",
+    "NYTGamesParseError",
+    "LatestDataStats",
+    "Wordle",
+]

nyt_games-0.1.0/src/nyt_games/exceptions.py

@@ -0,0 +1,13 @@
+"""Asynchronous Python client for NYT Games."""
+
+
+class NYTGamesError(Exception):
+    """Generic exception."""
+
+
+class NYTGamesConnectionError(NYTGamesError):
+    """NYT Games connection exception."""
+
+
+class NYTGamesParseError(NYTGamesError):
+    """NYT Games parse exception."""

nyt_games-0.1.0/src/nyt_games/models.py

@@ -0,0 +1,48 @@
+"""Models for NYT Games."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from datetime import date  # noqa: TCH003
+from typing import Any
+
+from mashumaro import field_options
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+
+@dataclass
+class LatestData(DataClassORJSONMixin):
+    """LatestData model."""
+
+    player: LatestDataPlayer
+
+
+@dataclass
+class LatestDataPlayer(DataClassORJSONMixin):
+    """LatestData model."""
+
+    stats: LatestDataStats
+
+
+@dataclass
+class LatestDataStats(DataClassORJSONMixin):
+    """LatestData model."""
+
+    wordle: Wordle
+
+
+@dataclass
+class Wordle(DataClassORJSONMixin):
+    """Wordle model."""
+
+    games_played: int = field(metadata=field_options(alias="gamesPlayed"))
+    games_won: int = field(metadata=field_options(alias="gamesWon"))
+    guesses: dict[str, int]
+    current_streak: int = field(metadata=field_options(alias="currentStreak"))
+    max_streak: int = field(metadata=field_options(alias="maxStreak"))
+    last_won: date = field(metadata=field_options(alias="lastWonPrintDate"))
+
+    @classmethod
+    def __pre_deserialize__(cls, d: dict[str, dict[str, Any]]) -> dict[str, Any]:
+        """Pre deserialization hook."""
+        return d["calculatedStats"]

nyt_games-0.1.0/src/nyt_games/nyt_games.py

@@ -0,0 +1,108 @@
+"""Asynchronous Python client for NYT Games."""
+
+from __future__ import annotations
+
+import asyncio
+from dataclasses import dataclass
+from importlib import metadata
+import socket
+from typing import TYPE_CHECKING
+
+from aiohttp import ClientError, ClientResponseError, ClientSession
+from yarl import URL
+
+from .exceptions import NYTGamesConnectionError
+from .models import LatestData, LatestDataStats
+
+if TYPE_CHECKING:
+    from typing_extensions import Self
+
+
+VERSION = metadata.version(__package__)
+
+
+@dataclass
+class NYTGamesClient:
+    """Main class for handling connections with NYT Games."""
+
+    token: str
+    session: ClientSession | None = None
+    request_timeout: int = 10
+    _close_session: bool = False
+
+    async def _request(self, uri: str) -> str:
+        """Handle a request to NYT Games."""
+        url = URL.build(
+            scheme="https",
+            host="nytimes.com",
+            port=443,
+        ).joinpath(uri)
+
+        headers = {
+            "User-Agent": f"PythonNYTGames/{VERSION}",
+            "Accept": "application/json",
+        }
+
+        if self.session is None:
+            self.session = ClientSession()
+            self._close_session = True
+        self.session.cookie_jar.update_cookies({"NYT-S": self.token})
+
+        try:
+            async with asyncio.timeout(self.request_timeout):
+                response = await self.session.get(
+                    url,
+                    headers=headers,
+                )
+        except asyncio.TimeoutError as exception:
+            msg = "Timeout occurred while connecting to NYT Games"
+            raise NYTGamesConnectionError(msg) from exception
+        except (
+            ClientError,
+            ClientResponseError,
+            socket.gaierror,
+        ) as exception:
+            msg = "Error occurred while communicating with NYT Games"
+            raise NYTGamesConnectionError(msg) from exception
+
+        if response.status != 200:
+            content_type = response.headers.get("Content-Type", "")
+            text = await response.text()
+            msg = "Unexpected response from NYT Games"
+            raise NYTGamesConnectionError(
+                msg,
+                {"Content-Type": content_type, "response": text},
+            )
+
+        return await response.text()
+
+    async def get_latest_stats(self) -> LatestDataStats:
+        """Get latest stats."""
+        response = await self._request("svc/games/state/wordleV2/latests")
+        data = LatestData.from_json(response)
+        return data.player.stats
+
+    async def close(self) -> None:
+        """Close open client session."""
+        if self.session and self._close_session:
+            await self.session.close()
+
+    async def __aenter__(self) -> Self:
+        """Async enter.
+
+        Returns
+        -------
+            The NYTGamesClient object.
+
+        """
+        return self
+
+    async def __aexit__(self, *_exc_info: object) -> None:
+        """Async exit.
+
+        Args:
+        ----
+            _exc_info: Exec type.
+
+        """
+        await self.close()