vlrdevapi 2.1.0__tar.gz → 2.3.0__tar.gz

{vlrdevapi-2.1.0 → vlrdevapi-2.3.0}/.gitattributes

@@ -4,4 +4,8 @@ docs-py/** linguist-vendored
 
 # Exclude test fixtures
 tests/test_html/** linguist-vendored
-tests/test_html/** linguist-detectable=false
+tests/test_html/** linguist-detectable=false
+
+# Normalize workflow YAML line endings
+*.yml text eol=lf
+*.yaml text eol=lf

vlrdevapi-2.3.0/.github/workflows/cleanup-caches.yml

@@ -0,0 +1,31 @@
+name: Cleanup docs-check caches on closed PRs
+
+on:
+  pull_request:
+    types:
+      - closed
+
+permissions:
+  actions: write
+
+jobs:
+  cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Delete PR caches
+        env:
+          GH_TOKEN: ${{ github.token }}
+          GH_REPO: ${{ github.repository }}
+          BRANCH: refs/pull/${{ github.event.pull_request.number }}/merge
+        run: |
+          echo "Fetching list of cache keys"
+          cacheKeysForPR=$(gh cache list --ref $BRANCH --limit 100 --json id --jq '.[].id')
+
+          ## Setting this to not fail the workflow while deleting cache keys.
+          set +e
+          echo "Deleting caches..."
+          for cacheKey in $cacheKeysForPR
+          do
+            gh cache delete $cacheKey
+          done
+          echo "Done"

vlrdevapi-2.3.0/.github/workflows/docs-check.yml

@@ -0,0 +1,102 @@
+name: Docs Check
+
+on:
+  pull_request:
+    paths:
+      - 'official-docs/**'
+      - 'docs-py/**'
+  push:
+    branches: [main]
+    paths:
+      - 'official-docs/**'
+      - 'docs-py/**'
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+
+      - uses: astral-sh/setup-uv@08807647e7069bb48b6ef5acd8ec9567f424441b
+        with:
+          python-version: '3.12'
+
+      - name: Install package
+        run: uv sync --group dev
+
+      # main always validates live against fresh vlr.gg data; never uses the
+      # cache. Branch/PR runs reuse fixtures cached by earlier runs in the
+      # same PR (within a 2h TTL), falling back to live fetches for anything
+      # missing, so the check is correct even with a partially-stale cache.
+      - name: Run MDX examples check (main, live)
+        if: github.ref_name == 'main'
+        run: uv run scripts/check_mdx_examples.py --live
+
+      # actions/cache v6.1.0, pinned to a reviewed commit SHA.
+      - name: Restore fixture cache (branch)
+        id: mdx-fixtures
+        if: github.ref_name != 'main'
+        uses: actions/cache/restore@55cc8345863c7cc4c66a329aec7e433d2d1c52a9
+        with:
+          path: fixtures.tar.gz
+          key: mdx-fixtures-${{ github.ref_name }}-run-${{ github.run_id }}
+          restore-keys: |
+            mdx-fixtures-${{ github.ref_name }}-
+
+      - name: Unpack fixtures (branch)
+        if: github.ref_name != 'main'
+        run: |
+          if [ -f fixtures.tar.gz ]; then
+            mkdir -p .cache
+            tar -C .cache -xzf fixtures.tar.gz
+          fi
+
+      - name: Check fixture cache age (branch, 2h TTL)
+        id: cache-age
+        if: github.ref_name != 'main'
+        run: |
+          matched="${{ steps.mdx-fixtures.outputs.cache-matched-key }}"
+          now=$(date +%s)
+          if [ -n "$matched" ]; then
+            epoch="${matched##*-}"
+            age=$(( now - epoch ))
+          else
+            age=999999
+          fi
+          if [ "$age" -gt 7200 ]; then
+            rm -rf .cache/mdx-html
+            rm -f fixtures.tar.gz
+            mkdir -p .cache/mdx-html
+            echo "fresh=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "fresh=true" >> "$GITHUB_OUTPUT"
+          fi
+          echo "now=$now" >> "$GITHUB_OUTPUT"
+
+      - name: Run MDX examples check (branch)
+        if: github.ref_name != 'main'
+        run: |
+          if [ "${{ steps.cache-age.outputs.fresh }}" == "true" ]; then
+            uv run scripts/check_mdx_examples.py --skip-warm
+          else
+            uv run scripts/check_mdx_examples.py
+          fi
+
+      # always(): a run that fails validation still saved its warm fixtures,
+      # so the next fix commit restores and validates fast instead of warming.
+      - name: Package fixtures (branch)
+        if: always() && github.ref_name != 'main' && steps.cache-age.outputs.fresh == 'false'
+        run: |
+          mkdir -p .cache/mdx-html
+          if [ -n "$(ls -A .cache/mdx-html)" ]; then
+            tar -C .cache -czf fixtures.tar.gz mdx-html
+          else
+            rm -f fixtures.tar.gz
+          fi
+
+      - name: Save fixture cache (branch)
+        if: always() && github.ref_name != 'main' && steps.cache-age.outputs.fresh == 'false'
+        uses: actions/cache/save@55cc8345863c7cc4c66a329aec7e433d2d1c52a9
+        with:
+          path: fixtures.tar.gz
+          key: mdx-fixtures-${{ github.ref_name }}-${{ steps.cache-age.outputs.now }}

{vlrdevapi-2.1.0 → vlrdevapi-2.3.0}/.gitignore

@@ -9,6 +9,8 @@ wheels/
 # Virtual environments
 .venv
 tests/test_html/
+.cache/mdx-html/
+fixtures.tar.gz
 
 nul
 .pytest_cache/

{vlrdevapi-2.1.0 → vlrdevapi-2.3.0}/CHANGELOG.md

@@ -5,7 +5,58 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/),
 and this project adheres to [Semantic Versioning](https://semver.org/).
 
-## [Unreleased]
+## [2.3.0] - 2026-08-11
+
+### Added
+
+- **News namespace** — `vlrdevapi.news(page=1)` lists news items from
+  vlr.gg/news, each with `title`, `subtitle`, `link`, `country_name`,
+  `date`, and `author`, plus `has_next_page` and `page_number` on the
+  returned page.
+- **News article content** — `vlrdevapi.news.article(article_id)` fetches
+  a single news article with its `title`, `author`, `date`, associated
+  `event_name`/`event_link`, and the full `content` body text. The body
+  is also available as Markdown via `content_md`, preserving headings,
+  lists, links, emphasis, and clip embeds.
+- **News out-of-range pages** — requesting a news page beyond the last
+  available page (e.g. `page=176`) now raises `NotFoundError` instead of
+  silently returning an empty result.
+
+### Changed
+
+- **News article Markdown links are absolute** — links in `content_md` are
+  prefixed with `https://www.vlr.gg` when they were relative (e.g.
+  `/player/5132/mada` → `https://www.vlr.gg/player/5132/mada`). Absolute
+  and `www.`-prefixed URLs are left untouched. `NewsArticle.event_link` is
+  now an absolute URL as well.
+
+### Fixed
+
+- **News article clip embeds** — `content_md` clip embeds now link to the
+  directly openable watch URL (e.g. `https://clips.twitch.tv/<slug>`) for
+  Twitch clips, Twitch VODs, YouTube, and Soop embeds, instead of the embed
+  URL which could not be opened in a new tab.
+- **News article Markdown whitespace/emphasis** — inline emphasis and bold
+  render correctly around links: source indentation whitespace no longer
+  produces double spaces, and `*`/`**` markers no longer wrap whitespace.
+- **News article dates are timezone-aware** — the article date is parsed
+  through the shared `commons.parse_vlr_iso_datetime` helper. Offset-aware
+  `datetime` attributes are converted to UTC as-is; naive values are
+  localised to the client's `source_tz` (or UTC) instead of the local
+  machine timezone.
+- **Unknown article IDs raise `NotFoundError`** — vlr.gg returns a generic
+  HTTP 200 page for non-existent article IDs; `news.article()` now detects
+  the missing article card and raises `NotFoundError` instead of returning
+  an empty article.
+- **News article Markdown fidelity** — `content_md` now renders nested
+  lists, tables (as pipe tables), and inline `code` verbatim (whitespace
+  preserved). Links whose href is `www.`-prefixed are upgraded to
+  `https://`, fixing broken relative links in Markdown.
+- **Documentation** — news reference pages updated (article, list, index),
+  plus the getting-started guide, main docs index, and README now cover the
+  news namespace; model/parser docstrings describe the current behaviour.
+
+## [2.2.0] - 2026-08-11
 
 ### Changed
 
@@ -14,6 +65,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
   sentinel year of `2019` instead of the current year. Any parsed date with
   `year < 2020` means the source omitted the year, so guard with
   `event.start_date.year < 2020` before relying on it.
+- **Series performance field renames (breaking)** — `AdvStatsEntry` fields
+  were renamed to descriptive names: `econ` → `economy`, `pl` → `plants`,
+  and `de` → `defuses`. Update any code referencing the old field names.
+  The series performance reference docs were updated to match.
 
 ### Fixed
 
@@ -22,6 +77,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
   change behavior in Python 3.15). All such parses now supply an explicit
   year derived from context (reference date, page-header year, or the
   sentinel above).
+- **Series per-game stats by game number** — `players()`, `rounds()`,
+  `performance()`, and `economy()` game identifiers can now be a 1-based
+  game number within the series, resolved to the real VLR game ID from the
+  page's game nav tabs. A real VLR game ID is still accepted unchanged;
+  previously passing a game number produced empty results.
+- **Series economy and rounds scope** — economy and round-by-round data are
+  now parsed from the selected game's section only. The economy parser
+  previously collected tables from the whole page, so a per-game request
+  could include data from other maps.
+- **Series performance player IDs** — the performance tab renders player
+  cells without links, leaving player IDs as `0`. IDs are now recovered from
+  the series overview tab (keyed by team abbreviation and player name) and
+  attached to kill-matrix entries, advanced stats, and notable-round victims.
 
 ## [2.1.0] - 2026-08-07
 
@@ -125,6 +193,8 @@ The API surface, module structure, and type system are all new.
 - `aiohttp` and `asyncio` dependencies.
 - v1.x match/event/team parsing modules.
 
+[2.3.0]: https://github.com/Vanshbordia/vlrdevapi/compare/v2.2.0...v2.3.0
+[2.2.0]: https://github.com/Vanshbordia/vlrdevapi/compare/v2.1.0...v2.2.0
 [2.1.0]: https://github.com/Vanshbordia/vlrdevapi/compare/v2.0.1...v2.1.0
 [2.0.1]: https://github.com/Vanshbordia/vlrdevapi/compare/v2.0.0...v2.0.1
 [2.0.0]: https://github.com/Vanshbordia/vlrdevapi/compare/v1.6.2...v2.0.0

{vlrdevapi-2.1.0 → vlrdevapi-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vlrdevapi
-Version: 2.1.0
+Version: 2.3.0
 Summary: A Python library to scrape data from vlr.gg
 Project-URL: Homepage, https://vlrdevapi.pages.dev/
 Project-URL: Repository, https://github.com/Vanshbordia/vlrdevapi
@@ -68,7 +68,7 @@ Access Valorant esports data from VLR.gg with a clean, type-safe Python API. Get
 
 ## Features
 
-- **Complete Data Access** - Events, matches, players, teams, and series
+- **Complete Data Access** - Events, matches, players, teams, series, and news
 - **Type-Safe** - Pydantic models with rich type hints and field descriptions
 - **Production-Ready** - Retry logic, rate limiting, and LRU-cached enrichment
 - **Curried Access** - Bind a player/team/series ID once, then call sub-methods without re-passing
@@ -181,6 +181,17 @@ performance = s.performance()            # Advanced performance stats
 economy = s.economy(game_id=1)           # Economy data
 ```
 
+### News
+
+```python
+page = client.news(page=1)               # Browse the news listing
+for item in page.news[:5]:
+    print(item.title)
+
+article = client.news.article(734100)    # Fetch a full article
+print(article.content_md)                # Article body as Markdown
+```
+
 ## Documentation
 
 - **Official Docs** - [vlrdevapi.pages.dev/docs](https://vlrdevapi.pages.dev/docs)

{vlrdevapi-2.1.0 → vlrdevapi-2.3.0}/README.md

@@ -20,7 +20,7 @@ Access Valorant esports data from VLR.gg with a clean, type-safe Python API. Get
 
 ## Features
 
-- **Complete Data Access** - Events, matches, players, teams, and series
+- **Complete Data Access** - Events, matches, players, teams, series, and news
 - **Type-Safe** - Pydantic models with rich type hints and field descriptions
 - **Production-Ready** - Retry logic, rate limiting, and LRU-cached enrichment
 - **Curried Access** - Bind a player/team/series ID once, then call sub-methods without re-passing
@@ -133,6 +133,17 @@ performance = s.performance()            # Advanced performance stats
 economy = s.economy(game_id=1)           # Economy data
 ```
 
+### News
+
+```python
+page = client.news(page=1)               # Browse the news listing
+for item in page.news[:5]:
+    print(item.title)
+
+article = client.news.article(734100)    # Fetch a full article
+print(article.content_md)                # Article body as Markdown
+```
+
 ## Documentation
 
 - **Official Docs** - [vlrdevapi.pages.dev/docs](https://vlrdevapi.pages.dev/docs)

{vlrdevapi-2.1.0 → vlrdevapi-2.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "vlrdevapi"
-version = "2.1.0"
+version = "2.3.0"
 description = "A Python library to scrape data from vlr.gg"
 readme = "README.md"
 requires-python = ">=3.11"