repeaterbook 0.2.2__tar.gz → 0.3.0__tar.gz

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/MicaelJarniac/crustypy",
-  "commit": "3af00654de427f00c49ac2f2281ff3522f0b7416",
+  "commit": "83b2f3cc90f51cd07f50f7cdc5644b5c444b7dfc",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -21,7 +21,7 @@
       "__github_url": "https://github.com/MicaelJarniac/repeaterbook",
       "__readthedocs_name": "repeaterbook",
       "_template": "https://github.com/MicaelJarniac/crustypy",
-      "_commit": "3af00654de427f00c49ac2f2281ff3522f0b7416"
+      "_commit": "83b2f3cc90f51cd07f50f7cdc5644b5c444b7dfc"
     }
   },
   "directory": null

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/.readthedocs.yaml

@@ -14,10 +14,6 @@ build:
     install:
       - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --no-default-groups --group docs
 
-# Build from the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-
-formats:
-  - pdf
-  - epub
+# Build documentation with MkDocs
+mkdocs:
+  configuration: docs/mkdocs.yml

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: repeaterbook
-Version: 0.2.2
+Version: 0.3.0
 Summary: Python utility to work with data from RepeaterBook.
 Project-URL: homepage, https://github.com/MicaelJarniac/repeaterbook
 Project-URL: source, https://github.com/MicaelJarniac/repeaterbook
@@ -29,7 +29,7 @@ Requires-Dist: tqdm>=4.67.1
 Requires-Dist: yarl>=1.18.3
 Description-Content-Type: text/markdown
 
-<div align="center">
+<div align="center" markdown="1">
 
   [![Discord][badge-chat]][chat]
   <br>
@@ -106,6 +106,9 @@ Description-Content-Type: text/markdown
 <!---->
 
 # RepeaterBook
+
+Welcome to **RepeaterBook's** documentation!
+
 Python utility to work with data from RepeaterBook.
 
 [Read the Docs][docs]

repeaterbook-0.3.0/docs/CHANGELOG.md

@@ -0,0 +1,172 @@
+# CHANGELOG
+
+
+## v0.3.0 (2026-02-03)
+
+### Chores
+
+- **deps**: Bump aiohttp from 3.11.14 to 3.13.3
+  ([#6](https://github.com/MicaelJarniac/repeaterbook/pull/6),
+  [`5ac6362`](https://github.com/MicaelJarniac/repeaterbook/commit/5ac63626172f12e422fc4025d1eb3fbfcfe87d5f))
+
+--- updated-dependencies: - dependency-name: aiohttp dependency-version: 3.13.3
+
+dependency-type: direct:production ...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+
+- **deps**: Bump filelock from 3.18.0 to 3.20.3
+  ([#4](https://github.com/MicaelJarniac/repeaterbook/pull/4),
+  [`00e7717`](https://github.com/MicaelJarniac/repeaterbook/commit/00e7717186b77a8510ee6e0580bd1f13a4d495d6))
+
+Bumps [filelock](https://github.com/tox-dev/py-filelock) from 3.18.0 to 3.20.3. - [Release
+  notes](https://github.com/tox-dev/py-filelock/releases) -
+  [Changelog](https://github.com/tox-dev/filelock/blob/main/docs/changelog.rst) -
+  [Commits](https://github.com/tox-dev/py-filelock/compare/3.18.0...3.20.3)
+
+--- updated-dependencies: - dependency-name: filelock dependency-version: 3.20.3
+
+dependency-type: indirect ...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+
+- **deps**: Bump urllib3 from 2.3.0 to 2.6.3
+  ([#5](https://github.com/MicaelJarniac/repeaterbook/pull/5),
+  [`6870e08`](https://github.com/MicaelJarniac/repeaterbook/commit/6870e0894ef62164124096a7eba2a65d0da7637f))
+
+Bumps [urllib3](https://github.com/urllib3/urllib3) from 2.3.0 to 2.6.3. - [Release
+  notes](https://github.com/urllib3/urllib3/releases) -
+  [Changelog](https://github.com/urllib3/urllib3/blob/main/CHANGES.rst) -
+  [Commits](https://github.com/urllib3/urllib3/compare/2.3.0...2.6.3)
+
+--- updated-dependencies: - dependency-name: urllib3 dependency-version: 2.6.3
+
+dependency-type: indirect ...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+
+- **deps**: Bump virtualenv from 20.29.3 to 20.36.1
+  ([#3](https://github.com/MicaelJarniac/repeaterbook/pull/3),
+  [`89b2aa3`](https://github.com/MicaelJarniac/repeaterbook/commit/89b2aa32f1c18b988dac0e1894456fd4576930b7))
+
+Bumps [virtualenv](https://github.com/pypa/virtualenv) from 20.29.3 to 20.36.1. - [Release
+  notes](https://github.com/pypa/virtualenv/releases) -
+  [Changelog](https://github.com/pypa/virtualenv/blob/main/docs/changelog.rst) -
+  [Commits](https://github.com/pypa/virtualenv/compare/20.29.3...20.36.1)
+
+--- updated-dependencies: - dependency-name: virtualenv dependency-version: 20.36.1
+
+dependency-type: direct:production ...
+
+Signed-off-by: dependabot[bot] <support@github.com>
+
+Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
+
+### Features
+
+- Update Cruft ([#11](https://github.com/MicaelJarniac/repeaterbook/pull/11),
+  [`0c7c471`](https://github.com/MicaelJarniac/repeaterbook/commit/0c7c471d559a8814018a645767bd34dbe381b58f))
+
+* feat: update Cruft
+
+* chore: update Cruft
+
+### Testing
+
+- Add cache tests + opt-in live API integration
+  ([#7](https://github.com/MicaelJarniac/repeaterbook/pull/7),
+  [`804cedd`](https://github.com/MicaelJarniac/repeaterbook/commit/804cedd0a0abd51d6ea31653f893db9cecef454f))
+
+* test: add offline cache tests and opt-in live API integration tests
+
+* refactor: fix linting and type checking issues in tests
+
+- Add missing __init__.py to tests/integration/ package - Replace Any with proper StdPath type
+  annotations for tmp_path - Add missing docstring to test function - Fix line length violations (88
+  char limit) - Use more specific type:ignore[union-attr] for mypy - Extract magic number to named
+  constant - Move pathlib imports to TYPE_CHECKING block
+
+All linting (ruff) and type checking (mypy) now pass.
+
+Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
+
+* refactor(tests): extract local server fixture and clean up test code
+
+- Add local_server fixture in conftest.py to reduce test duplication - Simplify _live_enabled() with
+  case-insensitive comparison - Move pycountry import to module level in test_live_api.py - Extract
+  _NA_SAMPLE_SIZE constant for magic number 200 - Fix import organization (blank lines after
+  TYPE_CHECKING blocks)
+
+Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
+
+---------
+
+Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>
+
+
+## v0.2.2 (2026-01-31)
+
+### Bug Fixes
+
+- Tolerate RepeaterBook API drift ([#2](https://github.com/MicaelJarniac/repeaterbook/pull/2),
+  [`665d78e`](https://github.com/MicaelJarniac/repeaterbook/commit/665d78ee38ca856a242b8f5f6289c441f00193a2))
+
+* fix: tolerate RepeaterBook API drift (sponsor, NA fields, empty Use)
+
+* refactor: simplify Region parsing (use .get)
+
+* refactor: add b() helper for Yes/No + 1/0 fields
+
+
+## v0.2.1 (2025-04-09)
+
+### Chores
+
+- Links
+  ([`1d93cdb`](https://github.com/MicaelJarniac/repeaterbook/commit/1d93cdb5ae7dff17a6cb9943e66b2111f39617b5))
+
+
+## v0.2.0 (2025-04-08)
+
+### Bug Fixes
+
+- Use `and_` for `square` query
+  ([`9c09b5e`](https://github.com/MicaelJarniac/repeaterbook/commit/9c09b5eff8a2a4cef3dda91d5fa4d44001b0f241))
+
+### Features
+
+- Queries
+  ([`78972e5`](https://github.com/MicaelJarniac/repeaterbook/commit/78972e5cbdcd150dd9e6435d5dd5c759bb22f96b))
+
+
+## v0.1.1 (2025-04-03)
+
+### Bug Fixes
+
+- Merge instead of add to local DB
+  ([`f6dfcbf`](https://github.com/MicaelJarniac/repeaterbook/commit/f6dfcbf242c9af07578d5a2e8e19047ee2db96b9))
+
+### Chores
+
+- Dunder all as tuples
+  ([`2dfb808`](https://github.com/MicaelJarniac/repeaterbook/commit/2dfb8089fee6db5fc26b9d3ea986fe8f9ce86cd3))
+
+- Simpler working dir default
+  ([`fecdd43`](https://github.com/MicaelJarniac/repeaterbook/commit/fecdd4353fb37f46d42de3b6da69d7d402b76742))
+
+
+## v0.1.0 (2025-03-31)
+
+### Features
+
+- Initial release
+  ([`2a257dd`](https://github.com/MicaelJarniac/repeaterbook/commit/2a257ddaada98ffa6871e607a868aabf6556bae1))
+
+
+## v0.0.0 (2025-03-21)

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/docs/CONTRIBUTING.md

@@ -246,19 +246,19 @@ pytest --cov
 
 ### Docs
 
-Sphinx is used to automatically parse docstrings and generate documentation.
+MkDocs Material is used to build the documentation, with mkdocstrings to automatically generate API documentation from docstrings.
 
 ```bash
-# Change dir to /docs
-cd docs/
+# Build documentation
+nox -s docs
 
-# Update files index
-sphinx-apidoc -f -o ./source ..
+# Serve documentation locally with live reload
+nox -s docs_serve
 
-# Build HTML docs
-make html
-# On Windows
-./make.bat html
+# Or use mkdocs directly
+cd docs/
+mkdocs build --strict  # Build HTML docs
+mkdocs serve           # Serve with live reload at http://127.0.0.1:8000
 ```
 
 ### Requirements

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/docs/README.md

@@ -1,4 +1,4 @@
-<div align="center">
+<div align="center" markdown="1">
 
   [![Discord][badge-chat]][chat]
   <br>
@@ -75,6 +75,9 @@
 <!---->
 
 # RepeaterBook
+
+Welcome to **RepeaterBook's** documentation!
+
 Python utility to work with data from RepeaterBook.
 
 [Read the Docs][docs]

repeaterbook-0.3.0/docs/api.md

@@ -0,0 +1,22 @@
+# API Reference
+
+This page provides detailed API documentation for RepeaterBook.
+
+## Main Module
+
+::: repeaterbook
+    options:
+      show_root_heading: true
+      show_source: true
+      docstring_style: google
+      docstring_section_style: table
+      show_signature_annotations: true
+      separate_signature: true
+      merge_init_into_class: true
+      filters:
+        - "!^_"
+      members_order: source
+      group_by_category: true
+      show_category_heading: true
+      show_symbol_type_heading: true
+      show_symbol_type_toc: true

repeaterbook-0.3.0/docs/javascripts/extra.js

@@ -0,0 +1,8 @@
+/**
+ * Custom JavaScript for RepeaterBook documentation
+ *
+ * Add any custom scripts here to enhance functionality.
+ */
+
+// Example: Log page load
+// console.log('RepeaterBook documentation loaded');

repeaterbook-0.3.0/docs/mkdocs.yml

@@ -0,0 +1,141 @@
+site_name: "RepeaterBook"
+site_description: "Python utility to work with data from RepeaterBook."
+site_url: "https://repeaterbook.readthedocs.io"
+repo_url: "https://github.com/MicaelJarniac/repeaterbook"
+repo_name: "MicaelJarniac/repeaterbook"
+copyright: "Copyright © 2025, Micael Jarniac"
+
+# Documentation source directory (relative to this config file)
+docs_dir: "."
+# Build output directory (outside docs dir to avoid conflicts)
+site_dir: "../site"
+
+theme:
+  name: material
+  palette:
+    # Light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    # Dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - announce.dismiss
+    - content.code.annotate
+    - content.code.copy
+    - content.tabs.link
+    - navigation.expand
+    - navigation.footer
+    - navigation.indexes
+    - navigation.sections
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
+  icon:
+    repo: fontawesome/brands/github
+
+plugins:
+  - search:
+      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [src]
+          options:
+            docstring_style: google
+            docstring_section_style: table
+            show_root_heading: true
+            show_source: true
+            show_signature_annotations: true
+            separate_signature: true
+            merge_init_into_class: true
+            filters:
+              - "!^_"
+            members_order: source
+            group_by_category: true
+            show_category_heading: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+  - autorefs
+
+markdown_extensions:
+  # Python Markdown
+  - abbr
+  - admonition
+  - attr_list
+  - def_list
+  - footnotes
+  - md_in_html
+  - tables
+  - toc:
+      permalink: true
+      toc_depth: 4
+  # Python Markdown Extensions
+  - pymdownx.arithmatex:
+      generic: true
+  - pymdownx.betterem:
+      smart_enable: all
+  - pymdownx.caret
+  - pymdownx.details
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.keys
+  - pymdownx.mark
+  - pymdownx.smartsymbols
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.tasklist:
+      custom_checkbox: true
+  - pymdownx.tilde
+
+nav:
+  - Home: README.md
+  - Contributing:
+    - Guide: CONTRIBUTING.md
+    - Code of Conduct: CODE_OF_CONDUCT.md
+  - Reference:
+    - Tools & Standards: reference.md
+    - API Reference: api.md
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: "https://github.com/MicaelJarniac/repeaterbook"
+      name: GitHub Repository
+    - icon: fontawesome/brands/python
+      link: "https://pypi.org/project/repeaterbook"
+      name: PyPI Package
+  version:
+    provider: mike
+
+extra_css:
+  - stylesheets/extra.css
+
+extra_javascript:
+  - javascripts/extra.js

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/docs/reference.md

@@ -37,10 +37,9 @@
     - [airspeed velocity (`asv`)][asv]
     - [Coverage.py][coveragepy] <sup>[config][pyproject_toml]</sup>
   - Documenting
-    - [Sphinx][sphinx] <sup>[config][docs_conf_py]</sup>
-      - [Furo][furo]
-      - [sphinxcontrib-spelling][sphinxcontrib-spelling]
-      - [MyST][myst]
+    - [MkDocs][mkdocs] <sup>[config][docs_mkdocs_yml]</sup>
+      - [Material for MkDocs][mkdocs-material]
+      - [mkdocstrings][mkdocstrings]
     - [Google style docstrings][docstring_google]
   - Building
     - [uv][uv]
@@ -49,7 +48,7 @@
     - [`pyproject.toml`][pyproject_toml]
     - [`.pre-commit-config.yaml`][_pre-commit-config_yaml]
     - [`.editorconfig`][_editorconfig]
-    - [`docs/conf.py`][docs_conf_py]
+    - [`docs/mkdocs.yml`][docs_mkdocs_yml]
     - [`docs/wordlist.txt`][docs_wordlist_txt]
     - [`noxfile.py`][noxfile_py]
 - Standards
@@ -77,7 +76,7 @@
 [_pre-commit-config_yaml]: ../.pre-commit-config.yaml
 [pyproject_toml]: ../pyproject.toml
 [_editorconfig]: ../.editorconfig
-[docs_conf_py]: ./conf.py
+[docs_mkdocs_yml]: ./mkdocs.yml
 [docs_wordlist_txt]: ./wordlist.txt
 [noxfile_py]: ../noxfile.py
 
@@ -100,11 +99,10 @@
 [nox]: https://github.com/wntrblm/nox
 [cruft]: https://github.com/cruft/cruft/
 [cookiecutter]: https://github.com/cookiecutter/cookiecutter
-[sphinx]: https://www.sphinx-doc.org
-[furo]: https://github.com/pradyunsg/furo
-[sphinxcontrib-spelling]: https://github.com/sphinx-contrib/spelling
-[myst]: https://github.com/executablebooks/myst-parser
-[docstring_google]: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+[mkdocs]: https://www.mkdocs.org
+[mkdocs-material]: https://squidfunk.github.io/mkdocs-material
+[mkdocstrings]: https://mkdocstrings.github.io
+[docstring_google]: https://mkdocstrings.github.io/griffe/docstrings/#google-style
 [uv]: https://docs.astral.sh/uv
 [conventionalcommits]: https://www.conventionalcommits.org
 [semver]: https://semver.org

repeaterbook-0.3.0/docs/stylesheets/extra.css

@@ -0,0 +1,11 @@
+/**
+ * Custom CSS for RepeaterBook documentation
+ *
+ * Add any custom styles here to override Material theme defaults.
+ */
+
+/* Example: Customize code block background
+.highlight {
+    background-color: #f5f5f5;
+}
+*/

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/noxfile.py

@@ -88,3 +88,17 @@ def test_code(session: nox.Session) -> None:
     """Test code."""
     install(session, groups=["tests"], root=True, extras=True)
     session.run("pytest")
+
+
+@nox.session(python=python_version)
+def docs(session: nox.Session) -> None:
+    """Build documentation with MkDocs."""
+    install(session, groups=["docs"], root=True)
+    session.run("mkdocs", "build", "-f", "docs/mkdocs.yml")
+
+
+@nox.session(python=python_version)
+def docs_serve(session: nox.Session) -> None:
+    """Serve documentation locally with live reload."""
+    install(session, groups=["docs"], root=True)
+    session.run("mkdocs", "serve", "-f", "docs/mkdocs.yml")

{repeaterbook-0.2.2 → repeaterbook-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "repeaterbook"
-version = "0.2.2"
+version = "0.3.0"
 description = "Python utility to work with data from RepeaterBook."
 authors = [
   {name = "Micael Jarniac", email = "micael@jarniac.dev"},
@@ -57,10 +57,10 @@ benchmarking = [
     "virtualenv>=20.29.1",
 ]
 docs = [
-    "furo>=2024.8.6",
-    "myst-parser>=3.0.1",
-    "sphinx>=7.4.7",
-    "sphinxcontrib-spelling>=8.0.0",
+    "mkdocs>=1.5.3",
+    "mkdocs-material>=9.5.2",
+    "mkdocstrings[python]>=0.24.0",
+    "mkdocs-autorefs>=0.5.0",
 ]
 typing = [
     {include-group = "tests"},
@@ -159,6 +159,9 @@ command_line = "-m pytest"
 
 [tool.pytest.ini_options]
 # addopts = "--cov"
+markers = [
+  "integration: hits the live repeaterbook.com API (disabled by default)",
+]
 
 [tool.inline-snapshot]
 format-command = "ruff format --stdin-filename {filename}"

repeaterbook-0.3.0/tests/conftest.py

@@ -0,0 +1,65 @@
+"""Pytest configuration for repeaterbook.
+
+We run async tests using AnyIO but only require the asyncio backend.
+"""
+
+from __future__ import annotations
+
+from collections.abc import Awaitable, Callable
+from contextlib import asynccontextmanager
+from typing import TYPE_CHECKING, Any
+
+import pytest
+from aiohttp import web
+from yarl import URL
+
+if TYPE_CHECKING:
+    from collections.abc import AsyncIterator
+
+    from aiohttp.web import Request, StreamResponse
+
+# Type alias for aiohttp route handlers.
+_Handler = Callable[["Request"], Awaitable["StreamResponse"]]
+
+
+@pytest.fixture
+def anyio_backend() -> str:
+    """Force AnyIO tests to run on asyncio.
+
+    This avoids requiring trio as a test dependency.
+    """
+    return "asyncio"
+
+
+@pytest.fixture
+def local_server() -> Any:  # noqa: ANN401
+    """Provide an async context manager for spinning up a local aiohttp test server.
+
+    Usage:
+        async with local_server(my_handler) as url:
+            response = await fetch_json(url, ...)
+
+    The server binds to an ephemeral port on 127.0.0.1 and returns the base URL.
+    """
+
+    @asynccontextmanager
+    async def _create_server(
+        handler: _Handler,
+        path: str = "/data",
+    ) -> AsyncIterator[URL]:
+        app = web.Application()
+        app.router.add_get(path, handler)
+
+        runner = web.AppRunner(app)
+        await runner.setup()
+        site = web.TCPSite(runner, "127.0.0.1", 0)
+        await site.start()
+
+        try:
+            # Get ephemeral port from the bound socket.
+            port = site._server.sockets[0].getsockname()[1]  # type: ignore[union-attr]  # noqa: SLF001
+            yield URL.build(scheme="http", host="127.0.0.1", port=port, path=path)
+        finally:
+            await runner.cleanup()
+
+    return _create_server

repeaterbook-0.3.0/tests/integration/__init__.py

@@ -0,0 +1 @@
+"""Live API integration tests."""