wow 0.1.0__tar.gz

wow-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Jacob Coffee
+
+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.

wow-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: wow
+Version: 0.1.0
+Summary: Typed sync and async client for the World of Warcraft: Forever Battle.net API.
+Keywords: api,battle.net,blizzard,sdk,warcraft,wow,wow-forever
+Author: Jacob Coffee
+Author-email: Jacob Coffee <jacob@z7x.org>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AnyIO
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Games/Entertainment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: anyio>=4.11
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: msgspec>=0.20
+Requires-Python: >=3.14
+Project-URL: Changelog, https://github.com/SideQuest-Guild/wow-forever-sdk/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://docs.sidequest-guild.com/developers/wow-forever-sdk/
+Project-URL: Issues, https://github.com/SideQuest-Guild/wow-forever-sdk/issues
+Project-URL: Repository, https://github.com/SideQuest-Guild/wow-forever-sdk
+Description-Content-Type: text/markdown
+
+# wow
+
+A typed Python client for the **World of Warcraft: Forever** Battle.net API, sync and async.
+
+- `Client` and `AsyncClient` have the same methods. The async client runs under asyncio and trio.
+- Each response becomes a typed, immutable [msgspec](https://msgspec.dev) model. A new field from Blizzard never stops
+  a response from decoding.
+- The client gets, caches and refreshes app tokens for you. Profile routes use a player's token from the OAuth login.
+- The client retries connection errors, timeouts, 408, 429 and 5xx responses, and obeys `Retry-After`.
+- Search takes filters, ranges and sort orders, and `search_all` reads every page for you.
+
+Blizzard does not document a Forever API. Players found the namespaces `static-forever-{region}`,
+`dynamic-forever-{region}` and `profile-forever-{region}` by trial. This package covers the routes that answer today.
+
+## Install
+
+```console
+uv add wow
+```
+
+The package needs Python 3.14 or later.
+
+## Quick start
+
+Create an API client at https://develop.battle.net/access/clients. Then:
+
+```python
+from wow import Client
+
+with Client(client_id="...", client_secret="...") as client:  # or BATTLENET_CLIENT_ID/SECRET env vars
+    warrior = client.playable_classes.get(1)
+    print(warrior.name, [spec.name for spec in warrior.specializations])
+
+    for hit in client.items.search_all(name="Thunderfury"):
+        print(hit.data.id, hit.data.name["en_US"])
+```
+
+The async client has the same calls with `await`:
+
+```python
+from wow import AsyncClient
+
+async with AsyncClient(region="eu") as client:
+    races = await client.playable_races.index()
+```
+
+## What it covers
+
+| Namespace | Resources |
+| --- | --- |
+| static | `achievements`, `achievement_categories`, `creature_families`, `creature_types`, `items`, `item_classes`, `item_sets`, `mounts`, `pets`, `playable_classes`, `playable_races`, `playable_specializations`, `power_types`, `professions`, `quests`, `quest_areas`, `quest_categories`, `quest_types`, `recipes`, `reputation_factions`, `reputation_tiers`, `talents`, `talent_trees`, `titles`, `toys` |
+| dynamic | `regions`, `realms`, `rulesets` |
+| profile | `characters` and `guilds`, which an app token can read; `account`, which needs a player's token |
+
+For any other route, call `client.get(path, namespace=...)`. It returns the raw response.
+
+## Documentation
+
+The guide is at https://docs.sidequest-guild.com/developers/wow-forever-sdk/ and the full API reference at
+https://docs.sidequest-guild.com/reference/wow-forever-sdk/.
+
+## Development
+
+```console
+make install   # uv sync --locked
+make ci        # lint, format, types, generated code, tests at 100% coverage, docs, build
+make help      # every target
+```
+
+`make generate` writes `src/wow/_sync` from `src/wow/_async`. Edit the async code only.
+
+## License
+
+MIT

wow-0.1.0/README.md

@@ -0,0 +1,74 @@
+# wow
+
+A typed Python client for the **World of Warcraft: Forever** Battle.net API, sync and async.
+
+- `Client` and `AsyncClient` have the same methods. The async client runs under asyncio and trio.
+- Each response becomes a typed, immutable [msgspec](https://msgspec.dev) model. A new field from Blizzard never stops
+  a response from decoding.
+- The client gets, caches and refreshes app tokens for you. Profile routes use a player's token from the OAuth login.
+- The client retries connection errors, timeouts, 408, 429 and 5xx responses, and obeys `Retry-After`.
+- Search takes filters, ranges and sort orders, and `search_all` reads every page for you.
+
+Blizzard does not document a Forever API. Players found the namespaces `static-forever-{region}`,
+`dynamic-forever-{region}` and `profile-forever-{region}` by trial. This package covers the routes that answer today.
+
+## Install
+
+```console
+uv add wow
+```
+
+The package needs Python 3.14 or later.
+
+## Quick start
+
+Create an API client at https://develop.battle.net/access/clients. Then:
+
+```python
+from wow import Client
+
+with Client(client_id="...", client_secret="...") as client:  # or BATTLENET_CLIENT_ID/SECRET env vars
+    warrior = client.playable_classes.get(1)
+    print(warrior.name, [spec.name for spec in warrior.specializations])
+
+    for hit in client.items.search_all(name="Thunderfury"):
+        print(hit.data.id, hit.data.name["en_US"])
+```
+
+The async client has the same calls with `await`:
+
+```python
+from wow import AsyncClient
+
+async with AsyncClient(region="eu") as client:
+    races = await client.playable_races.index()
+```
+
+## What it covers
+
+| Namespace | Resources |
+| --- | --- |
+| static | `achievements`, `achievement_categories`, `creature_families`, `creature_types`, `items`, `item_classes`, `item_sets`, `mounts`, `pets`, `playable_classes`, `playable_races`, `playable_specializations`, `power_types`, `professions`, `quests`, `quest_areas`, `quest_categories`, `quest_types`, `recipes`, `reputation_factions`, `reputation_tiers`, `talents`, `talent_trees`, `titles`, `toys` |
+| dynamic | `regions`, `realms`, `rulesets` |
+| profile | `characters` and `guilds`, which an app token can read; `account`, which needs a player's token |
+
+For any other route, call `client.get(path, namespace=...)`. It returns the raw response.
+
+## Documentation
+
+The guide is at https://docs.sidequest-guild.com/developers/wow-forever-sdk/ and the full API reference at
+https://docs.sidequest-guild.com/reference/wow-forever-sdk/.
+
+## Development
+
+```console
+make install   # uv sync --locked
+make ci        # lint, format, types, generated code, tests at 100% coverage, docs, build
+make help      # every target
+```
+
+`make generate` writes `src/wow/_sync` from `src/wow/_async`. Edit the async code only.
+
+## License
+
+MIT

wow-0.1.0/pyproject.toml

@@ -0,0 +1,179 @@
+[build-system]
+build-backend = "uv_build"
+requires = ["uv-build>=0.13.7,<0.14"]
+
+[project]
+name = "wow"
+version = "0.1.0"
+description = "Typed sync and async client for the World of Warcraft: Forever Battle.net API."
+readme = "README.md"
+keywords = [
+    "api",
+    "battle.net",
+    "blizzard",
+    "sdk",
+    "warcraft",
+    "wow",
+    "wow-forever",
+]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.14"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Framework :: AnyIO",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Topic :: Games/Entertainment",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "anyio>=4.11",
+    "httpx>=0.28.1",
+    "msgspec>=0.20",
+]
+
+[[project.authors]]
+name = "Jacob Coffee"
+email = "jacob@z7x.org"
+
+[project.urls]
+Changelog = "https://github.com/SideQuest-Guild/wow-forever-sdk/blob/main/CHANGELOG.md"
+Documentation = "https://docs.sidequest-guild.com/developers/wow-forever-sdk/"
+Issues = "https://github.com/SideQuest-Guild/wow-forever-sdk/issues"
+Repository = "https://github.com/SideQuest-Guild/wow-forever-sdk"
+
+[dependency-groups]
+test = [
+    "pytest>=9",
+    "pytest-cov>=7",
+    "respx>=0.23",
+    "trio>=0.31",
+]
+docs = [
+    "myst-parser>=4",
+    "shibuya>=2025.1",
+    "sphinx>=8.1",
+    "sphinx-autobuild>=2024.10",
+    "sphinx-copybutton>=0.5",
+]
+lint = [
+    "codespell>=2.4",
+    "prek>=0.5",
+    "pyproject-fmt>=2.30",
+    "pyrefly>=1.4",
+    "ruff>=0.17",
+    "zizmor>=1.30",
+]
+
+[[dependency-groups.dev]]
+include-group = "docs"
+
+[[dependency-groups.dev]]
+include-group = "lint"
+
+[[dependency-groups.dev]]
+include-group = "test"
+
+[tool.uv]
+default-groups = ["dev"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "COM812",
+    "CPY001",
+    "D105",
+    "D107",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"docs/conf.py" = [
+    "A001",
+    "D",
+    "INP001",
+]
+"scripts/**" = [
+    "D",
+    "INP001",
+    "S",
+    "T201",
+]
+"src/wow/_sync/**" = ["UP028"]
+"tests/**" = [
+    "ANN",
+    "ARG001",
+    "D",
+    "PLR2004",
+    "S101",
+    "S105",
+    "S106",
+    "SLF001",
+]
+
+[tool.ruff.lint.flake8-tidy-imports.banned-api."__future__.annotations"]
+msg = "Python 3.14 evaluates annotations lazily (PEP 649); drop this import."
+
+[tool.ruff.lint.flake8-type-checking]
+runtime-evaluated-base-classes = [
+    "msgspec.Struct",
+    "wow.models._common.Document",
+    "wow.models._common.Model",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["wow"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.pylint]
+max-args = 10
+
+[tool.codespell]
+skip = "uv.lock,pyrefly-baseline.json,./tests/fixtures,./docs/_build,./.venv,./htmlcov,./dist"
+
+[tool.pyrefly]
+python-version = "3.14"
+project-includes = [
+    "docs/conf.py",
+    "scripts",
+    "src",
+    "tests",
+]
+search-path = [
+    "src",
+    ".",
+]
+baseline = "pyrefly-baseline.json"
+preset = "strict"
+
+[tool.pytest]
+addopts = [
+    "--strict-markers",
+    "--strict-config",
+    "-ra",
+]
+filterwarnings = ["error"]
+testpaths = ["tests"]
+xfail_strict = true
+
+[tool.coverage.run]
+source = ["wow"]
+branch = true
+
+[tool.coverage.report]
+fail_under = 100
+exclude_also = ["if TYPE_CHECKING:"]
+skip_covered = true
+show_missing = true

wow-0.1.0/pyproject.toml.orig

@@ -0,0 +1,118 @@
+[build-system]
+build-backend = "uv_build"
+requires = [ "uv-build>=0.13.7,<0.14" ]
+
+[project]
+name = "wow"
+version = "0.1.0"
+description = "Typed sync and async client for the World of Warcraft: Forever Battle.net API."
+readme = "README.md"
+keywords = [ "api", "battle.net", "blizzard", "sdk", "warcraft", "wow", "wow-forever" ]
+license = "MIT"
+license-files = [ "LICENSE" ]
+authors = [ { name = "Jacob Coffee", email = "jacob@z7x.org" } ]
+requires-python = ">=3.14"
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Framework :: AnyIO",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Topic :: Games/Entertainment",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+dependencies = [
+  "anyio>=4.11",
+  "httpx>=0.28.1",
+  "msgspec>=0.20",
+]
+urls.Changelog = "https://github.com/SideQuest-Guild/wow-forever-sdk/blob/main/CHANGELOG.md"
+urls.Documentation = "https://docs.sidequest-guild.com/developers/wow-forever-sdk/"
+urls.Issues = "https://github.com/SideQuest-Guild/wow-forever-sdk/issues"
+urls.Repository = "https://github.com/SideQuest-Guild/wow-forever-sdk"
+
+[dependency-groups]
+dev = [
+  { include-group = "docs" },
+  { include-group = "lint" },
+  { include-group = "test" },
+]
+test = [
+  "pytest>=9",
+  "pytest-cov>=7",
+  "respx>=0.23",
+  "trio>=0.31",
+]
+docs = [
+  "myst-parser>=4",
+  "shibuya>=2025.1",
+  "sphinx>=8.1",
+  "sphinx-autobuild>=2024.10",
+  "sphinx-copybutton>=0.5",
+]
+lint = [
+  "codespell>=2.4",
+  "prek>=0.5",
+  "pyproject-fmt>=2.30",
+  "pyrefly>=1.4",
+  "ruff>=0.17",
+  "zizmor>=1.30",
+]
+
+[tool.uv]
+default-groups = [ "dev" ]
+
+[tool.ruff]
+line-length = 120
+format.docstring-code-format = true
+lint.select = [ "ALL" ]
+lint.ignore = [
+  "COM812", # conflicts with the formatter
+  "CPY001", # no per-file copyright headers; LICENSE covers the project
+  "D105",   # magic methods document themselves
+  "D107",   # __init__ is documented on the class
+]
+lint.per-file-ignores."docs/conf.py" = [ "A001", "D", "INP001" ]
+lint.per-file-ignores."scripts/**" = [ "D", "INP001", "S", "T201" ]
+# The sync package is generated from async code, where `yield from` does not exist.
+lint.per-file-ignores."src/wow/_sync/**" = [ "UP028" ]
+lint.per-file-ignores."tests/**" = [ "ANN", "ARG001", "D", "PLR2004", "S101", "S105", "S106", "SLF001" ]
+lint.flake8-tidy-imports.banned-api."__future__.annotations".msg = """\
+  Python 3.14 evaluates annotations lazily (PEP 649); drop this import.\
+  """
+lint.flake8-type-checking.runtime-evaluated-base-classes = [
+  "msgspec.Struct",
+  "wow.models._common.Document",
+  "wow.models._common.Model",
+]
+lint.isort.known-first-party = [ "wow" ]
+lint.pydocstyle.convention = "google"
+lint.pylint.max-args = 10
+
+[tool.codespell]
+skip = "uv.lock,pyrefly-baseline.json,./tests/fixtures,./docs/_build,./.venv,./htmlcov,./dist"
+
+[tool.pyrefly]
+python-version = "3.14"
+project-includes = [ "docs/conf.py", "scripts", "src", "tests" ]
+search-path = [ "src", "." ]
+# Accepted errors live here and new ones fail CI; regenerate with `make type-baseline`.
+baseline = "pyrefly-baseline.json"
+preset = "strict"
+
+[tool.pytest]
+addopts = [ "--strict-markers", "--strict-config", "-ra" ]
+filterwarnings = [ "error" ]
+testpaths = [ "tests" ]
+xfail_strict = true
+
+[tool.coverage]
+run.source = [ "wow" ]
+run.branch = true
+report.fail_under = 100
+report.exclude_also = [ "if TYPE_CHECKING:" ]
+report.skip_covered = true
+report.show_missing = true

wow-0.1.0/src/wow/__init__.py

@@ -0,0 +1,52 @@
+"""Typed sync and async client for the World of Warcraft: Forever Battle.net API.
+
+>>> from wow import Client
+>>> with Client(client_id="...", client_secret="...") as client:  # doctest: +SKIP
+...     client.playable_classes.get(1).name
+'Warrior'
+"""
+
+from wow._async._client import AsyncClient
+from wow._base import OAuthToken
+from wow._exceptions import (
+    APIConnectionError,
+    APIError,
+    APIResponseValidationError,
+    APIStatusError,
+    APITimeoutError,
+    AuthenticationError,
+    BadRequestError,
+    InternalServerError,
+    NotFoundError,
+    PermissionDeniedError,
+    RateLimitError,
+    WowError,
+)
+from wow._response import APIResponse
+from wow._sync._client import Client
+from wow._types import Locale, NamespaceKind, Region
+from wow.search import Not, Range
+
+__all__ = [
+    "APIConnectionError",
+    "APIError",
+    "APIResponse",
+    "APIResponseValidationError",
+    "APIStatusError",
+    "APITimeoutError",
+    "AsyncClient",
+    "AuthenticationError",
+    "BadRequestError",
+    "Client",
+    "InternalServerError",
+    "Locale",
+    "NamespaceKind",
+    "Not",
+    "NotFoundError",
+    "OAuthToken",
+    "PermissionDeniedError",
+    "Range",
+    "RateLimitError",
+    "Region",
+    "WowError",
+]

wow-0.1.0/src/wow/_async/__init__.py

@@ -0,0 +1 @@
+"""The client implementation."""