xtools 0.1.2__tar.gz → 0.3.0__tar.gz

xtools-0.3.0/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.3
+Name: xtools
+Version: 0.3.0
+Summary: XTools API wrapper
+Author: Baptiste Fontaine
+Author-email: Baptiste Fontaine <b@ptistefontaine.fr>
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: requests>=2.28.2,<3
+Requires-Python: >=3.10, <4.0
+Project-URL: Homepage, https://github.com/bfontaine/xtools
+Description-Content-Type: text/markdown
+
+# xtools
+[![Version on Pypi](https://img.shields.io/pypi/v/xtools.svg?label=PyPI)](https://pypi.org/project/xtools/)
+
+**xtools** is a Python wrapper around [XTools][]’ API.
+
+[XTools]: https://xtools.readthedocs.io/en/stable/index.html
+
+Note this project is not affiliated with nor endorsed by XTools.
+
+## Install
+
+    pip install xtools
+
+### Requirements
+
+Python 3.10+.
+
+## Usage
+
+[Read the docs](https://python-xtools.readthedocs.io/en/latest/).

{xtools-0.1.2 → xtools-0.3.0}/README.md

@@ -1,6 +1,5 @@
 # xtools
-[![Version on Pypi](https://img.shields.io/pypi/v/xtools.svg?label=PyPI)](https://pypi.org/project/coveralls/)
-[![Coverage Status](https://coveralls.io/repos/github/bfontaine/xtools/badge.svg?branch=master)](https://coveralls.io/github/bfontaine/xtools?branch=master)
+[![Version on Pypi](https://img.shields.io/pypi/v/xtools.svg?label=PyPI)](https://pypi.org/project/xtools/)
 
 **xtools** is a Python wrapper around [XTools][]’ API.
 
@@ -14,8 +13,8 @@ Note this project is not affiliated with nor endorsed by XTools.
 
 ### Requirements
 
-Python 3.5+.
+Python 3.10+.
 
 ## Usage
 
-[Read the docs](https://python-xtools.readthedocs.io/en/latest/).
+[Read the docs](https://python-xtools.readthedocs.io/en/latest/).

xtools-0.3.0/pyproject.toml

@@ -0,0 +1,68 @@
+[project]
+name = "xtools"
+version = "0.3.0"
+description = "XTools API wrapper"
+authors = [{ name = "Baptiste Fontaine", email = "b@ptistefontaine.fr" }]
+requires-python = ">=3.10,<4.0"
+readme = "README.md"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = ["requests>=2.28.2,<3"]
+
+[project.urls]
+Homepage = "https://github.com/bfontaine/xtools"
+
+[dependency-groups]
+dev = [
+    "types-requests>=2.28.11.17,<3",
+    "mypy>=2,<3",
+    "pytest>=9,<10",
+    "sphinx>=8,<9",
+    "requests-mock>=1.10,<2",
+    "pytest-cov>=7,<8",
+    "ruff>=0.15.17",
+]
+
+[tool.uv]
+default-groups = "all"
+
+[tool.uv.build-backend]
+module-root = ""
+source-include = ["xtools/py.typed"]
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+[tool.ruff.lint]
+select = [
+    "PERF",
+    "W",
+    "F",
+    "UP",
+    "ASYNC",
+    # "A",
+    # "B",
+    # "PT",
+    "C4",
+    "PIE800",
+    "SIM",
+    "SLOT",
+    "YTT",
+    "PLE",
+    "FURB",
+    "PLC0207",
+]

xtools-0.3.0/xtools/__init__.py

@@ -0,0 +1,20 @@
+from .exceptions import BaseXToolsException, NotFound, TooManyEdits
+from .page import article_info, prose, links, top_editors, assessments
+from .project import (normalize_project, namespaces, page_assessments, page_assessments_configuration, automated_tools,
+                      admins_and_user_groups, admin_statistics, patroller_statistics, steward_statistics)
+from .quote import random_quote, single_quote, all_quotes
+from .user import (simple_edit_count, number_of_pages_created, pages_created, pages_created_iter,
+                   automated_edit_counter, non_automated_edits, automated_edits, edit_summaries, top_edits,
+                   category_edit_counter, log_counts, namespace_totals, month_counts, time_card)
+
+__version__ = "0.3.0"
+
+__all__ = (
+    "__version__", "article_info", "prose", "links", "top_editors", "assessments", "normalize_project", "namespaces",
+    "page_assessments", "page_assessments_configuration", "automated_tools", "admins_and_user_groups",
+    "admin_statistics", "patroller_statistics", "steward_statistics", "random_quote", "single_quote", "all_quotes",
+    "simple_edit_count", "number_of_pages_created", "pages_created", "pages_created_iter", "automated_edit_counter",
+    "non_automated_edits", "automated_edits", "edit_summaries", "top_edits", "category_edit_counter", "log_counts",
+    "namespace_totals", "month_counts", "time_card",
+    "BaseXToolsException", "NotFound", "TooManyEdits",
+)

{xtools-0.1.2 → xtools-0.3.0}/xtools/base.py

@@ -1,13 +1,14 @@
 """
 Internal base utilities.
 """
-
-from typing import Optional, Tuple, Any, Sequence
+import time
+from collections.abc import Sequence
 from json.decoder import JSONDecodeError
+from typing import Any
 from urllib.parse import quote as urlquote
 
-import time
 import requests
+
 from .exceptions import BaseXToolsException, NotFound, TooManyEdits
 
 BASE_URL = "https://xtools.wmflabs.org/api"
@@ -24,14 +25,14 @@ def url(path: str) -> str:
     return BASE_URL + path
 
 
-def error_exception(response: dict) -> Optional[BaseXToolsException]:
+def error_exception(response: dict[str, Any]) -> BaseXToolsException | None:
     """
     Return an optional Exception instance for an error response. Return ``None`` if the given response is not an error.
     :param response: response from the API.
     :return: ``None`` or a ``BaseXToolsException`` (or subclass) instance.
     """
     if "error" not in response:
-        return
+        return None
 
     error = response["error"]
 
@@ -54,7 +55,7 @@ def error_exception(response: dict) -> Optional[BaseXToolsException]:
     return BaseXToolsException(str(error))
 
 
-def get(path: str, params=None, retry=3, retry_delay=1):
+def get(path: str, params: dict[str, Any] | None = None, retry: int = 3, retry_delay: int = 1) -> dict[str, Any]:
     """
     Perform a GET request against the API.
     :param path:
@@ -72,7 +73,7 @@ def get(path: str, params=None, retry=3, retry_delay=1):
         r.raise_for_status()
 
     try:
-        response = r.json()
+        response: dict[str, Any] = r.json()
     except JSONDecodeError as e:
         r.raise_for_status()
         raise e
@@ -83,7 +84,7 @@ def get(path: str, params=None, retry=3, retry_delay=1):
     return response
 
 
-def build_path(path_format: str, params: Sequence[Tuple[str, Any, str]]) -> str:
+def build_path(path_format: str, params: Sequence[tuple[str, Any, str]]) -> str:
     """
     Build a path for the XTools API.
 
@@ -100,13 +101,10 @@ def build_path(path_format: str, params: Sequence[Tuple[str, Any, str]]) -> str:
     :param params:
     :return:
     """
-    params_dict = {}
+    params_dict: dict[str, str] = {}
 
-    def has_more(index):
-        for _, val, _ in params[index+1:]:
-            if val:
-                return True
-        return False
+    def has_more(index: int) -> bool:
+        return any(val for _, val, _ in params[index + 1:])
 
     for i, (name, value, default) in enumerate(params):
         if value:
@@ -126,4 +124,4 @@ def build_path(path_format: str, params: Sequence[Tuple[str, Any, str]]) -> str:
         params_dict[name] = urlquote(param_value)
 
     path = path_format.format(**params_dict).rstrip("/")
-    return path
+    return path

{xtools-0.1.2 → xtools-0.3.0}/xtools/exceptions.py

@@ -1,15 +1,15 @@
-from typing import Optional
+from typing import Any
 
 __all__ = ['BaseXToolsException', 'NotFound', 'TooManyEdits']
 
 
 class BaseXToolsException(Exception):
-    def __init__(self, message, code: Optional[int] = None):
+    def __init__(self, message: str, code: int | None = None) -> None:
         super().__init__(message)
         self.message = message
         self.code = code
 
-    def __eq__(self, other):
+    def __eq__(self, other: Any) -> bool:
         return isinstance(other, BaseXToolsException) \
             and str(self) == str(other) \
             and self.code == other.code
@@ -20,4 +20,4 @@ class NotFound(BaseXToolsException):
 
 
 class TooManyEdits(BaseXToolsException):
-    pass
+    pass

{xtools-0.1.2 → xtools-0.3.0}/xtools/page.py

@@ -4,13 +4,14 @@ Endpoints related to pages.
 https://xtools.readthedocs.io/en/stable/api/page.html
 """
 
-from typing import Optional, Sequence
+from collections.abc import Sequence
 from datetime import date
+from typing import Any
 
 from . import base
 
 
-def _get_page_dict(what: str, project: str, article: str) -> dict:
+def _get_page_dict(what: str, project: str, article: str) -> dict[str, Any]:
     return base.get(base.build_path("/page/{what}/{project}/{article}", (
         ("what", what, ""),
         ("project", project, ""),
@@ -18,7 +19,7 @@ def _get_page_dict(what: str, project: str, article: str) -> dict:
     )))
 
 
-def article_info(project: str, article: str) -> dict:
+def article_info(project: str, article: str) -> dict[str, Any]:
     """
     Return basic information about an article, such as page views, watchers, edits counts; author; assessment.
 
@@ -31,7 +32,7 @@ def article_info(project: str, article: str) -> dict:
     return _get_page_dict("articleinfo", project, article)
 
 
-def prose(project: str, article: str) -> dict:
+def prose(project: str, article: str) -> dict[str, Any]:
     """
     Return prose information about an article, such as references and words counts.
 
@@ -58,7 +59,7 @@ def prose(project: str, article: str) -> dict:
     return _get_page_dict("prose", project, article)
 
 
-def links(project: str, article: str) -> dict:
+def links(project: str, article: str) -> dict[str, Any]:
     """
     Return in and outgoing links counts of an article.
 
@@ -85,10 +86,10 @@ def links(project: str, article: str) -> dict:
 
 
 def top_editors(project: str, article: str,
-                start: Optional[date] = None,
-                end: Optional[date] = None,
-                limit: Optional[int] = None,
-                exclude_bots: bool = False) -> dict:
+                start: date | None = None,
+                end: date | None = None,
+                limit: int | None = None,
+                exclude_bots: bool = False) -> dict[str, Any]:
     """
     Get top editors on an article.
 
@@ -140,7 +141,7 @@ def top_editors(project: str, article: str,
 
 
 def assessments(project: str, articles: Sequence[str],
-                class_only: bool = False) -> dict:
+                class_only: bool = False) -> dict[str, Any]:
     """
     Get assessment data for the given articles.
 
@@ -178,4 +179,4 @@ def assessments(project: str, articles: Sequence[str],
     return base.get(base.build_path("/page/assessments/{project}/{articles}", (
         ("project", project, ""),
         ("articles", "|".join(articles), ""),
-    )), params)
+    )), params)

{xtools-0.1.2 → xtools-0.3.0}/xtools/project.py

@@ -3,18 +3,18 @@ Endpoints related to projects.
 
 https://xtools.readthedocs.io/en/stable/api/project.html
 """
-
-from typing import Optional, Sequence
+from collections.abc import Sequence
 from datetime import date
+from typing import Any
 
 from . import base
 
 
-def _get_project_dict(what: str, project: str) -> dict:
-    return base.get("/project/%s/%s" % (what, project))
+def _get_project_dict(what: str, project: str) -> dict[str, Any]:
+    return base.get(f"/project/{what}/{project}")
 
 
-def normalize_project(project: str) -> dict:
+def normalize_project(project: str) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/project.html#normalize-project
 
@@ -36,7 +36,7 @@ def normalize_project(project: str) -> dict:
     return _get_project_dict("normalize", project)
 
 
-def namespaces(project: str) -> dict:
+def namespaces(project: str) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/project.html#namespaces
 
@@ -46,7 +46,7 @@ def namespaces(project: str) -> dict:
     return _get_project_dict("namespaces", project)
 
 
-def page_assessments(project: str) -> dict:
+def page_assessments(project: str) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/project.html#page-assessments
 
@@ -56,7 +56,7 @@ def page_assessments(project: str) -> dict:
     return _get_project_dict("assessments", project)
 
 
-def page_assessments_configuration() -> dict:
+def page_assessments_configuration() -> dict[str, Any]:
     """
     Return the list of wikis that support page assessments and the configuration for each.
 
@@ -83,7 +83,7 @@ def page_assessments_configuration() -> dict:
     return base.get("/project/assessments")
 
 
-def automated_tools(project: str) -> dict:
+def automated_tools(project: str) -> dict[str, Any]:
     """
     Return a list of known (semi-)automated tools used on the project.
 
@@ -117,7 +117,7 @@ def automated_tools(project: str) -> dict:
     return _get_project_dict("automated_tools", project)
 
 
-def admins_and_user_groups(project: str) -> dict:
+def admins_and_user_groups(project: str) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/project.html#admins-and-user-groups
 
@@ -128,9 +128,9 @@ def admins_and_user_groups(project: str) -> dict:
 
 
 def _get_project_stats_dict(what: str, project: str,
-                            start: Optional[date] = None,
-                            end: Optional[date] = None,
-                            actions: Optional[Sequence[str]] = None) -> dict:
+                            start: date | None = None,
+                            end: date | None = None,
+                            actions: Sequence[str] | None = None) -> dict[str, Any]:
     path = base.build_path("/project/{what}/{project}/{start}/{end}", (
         ("what", what, ""),
         ("project", project, ""),
@@ -146,9 +146,9 @@ def _get_project_stats_dict(what: str, project: str,
 
 
 def admin_statistics(project: str,
-                     start: Optional[date] = None,
-                     end: Optional[date] = None,
-                     actions: Optional[Sequence[str]] = None) -> dict:
+                     start: date | None = None,
+                     end: date | None = None,
+                     actions: Sequence[str] | None = None) -> dict[str, Any]:
     """
     Return admin users of the project with counts of the actions they took.
 
@@ -167,27 +167,27 @@ def admin_statistics(project: str,
 
 
 def patroller_statistics(project: str,
-                         start: Optional[date] = None,
-                         end: Optional[date] = None,
-                         actions: Optional[Sequence[str]] = None) -> dict:
+                         start: date | None = None,
+                         end: date | None = None,
+                         actions: Sequence[str] | None = None) -> dict[str, Any]:
     """
     Same as ``admin_statistics`` with different actions.
 
     https://xtools.readthedocs.io/en/stable/api/project.html#patroller-statistics
 
-    :param project: 
-    :param start: 
-    :param end: 
+    :param project:
+    :param start:
+    :param end:
     :param actions: available actions include: ``patrol``, ``page-curation``, ``pc-accept``, ``pc-reject``.
-    :return: 
+    :return:
     """
     return _get_project_stats_dict("patroller_stats", project, start, end, actions)
 
 
 def steward_statistics(project: str,
-                       start: Optional[date] = None,
-                       end: Optional[date] = None,
-                       actions: Optional[Sequence[str]] = None) -> dict:
+                       start: date | None = None,
+                       end: date | None = None,
+                       actions: Sequence[str] | None = None) -> dict[str, Any]:
     """
     Same as ``admin_statistics`` with different actions.
 
@@ -200,4 +200,4 @@ def steward_statistics(project: str,
       ``global-unblock``, ``global-rename``, ``global-rights``, ``wiki-set-change``.
     :return:
     """
-    return _get_project_stats_dict("steward_stats", project, start, end, actions)
+    return _get_project_stats_dict("steward_stats", project, start, end, actions)

{xtools-0.1.2 → xtools-0.3.0}/xtools/quote.py

@@ -6,8 +6,9 @@ A Quote is a named tuple with ``id`` and ``text`` fields.
 https://xtools.readthedocs.io/en/stable/api/quote.html
 """
 
-from typing import Sequence
 from collections import namedtuple
+from collections.abc import Sequence
+from urllib.parse import quote as urlquote
 
 from . import base
 
@@ -44,7 +45,7 @@ def single_quote(quote_id: int) -> Quote:
     :param quote_id:
     :return: Quote.
     """
-    return _get_quotes("/quote/%d" % quote_id)[0]
+    return _get_quotes(f"/quote/{urlquote(str(quote_id))}")[0]
 
 
 def all_quotes() -> Sequence[Quote]:
@@ -55,4 +56,4 @@ def all_quotes() -> Sequence[Quote]:
 
     :return: sequence of Quote objects.
     """
-    return _get_quotes("/quote/all")
+    return _get_quotes("/quote/all")

{xtools-0.1.2 → xtools-0.3.0}/xtools/user.py

@@ -4,16 +4,18 @@ Endpoints related to users.
 https://xtools.readthedocs.io/en/stable/api/user.html
 """
 
-from typing import Optional, Generator, Sequence
+from collections.abc import Generator, Sequence
 from datetime import date
+from typing import Any
 
 from . import base
+import contextlib
 
 
 def simple_edit_count(project: str, username: str,
-                      namespace: Optional[int] = None,
-                      start: Optional[date] = None,
-                      end: Optional[date] = None) -> dict:
+                      namespace: int | None = None,
+                      start: date | None = None,
+                      end: date | None = None) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/user.html#simple-edit-count
 
@@ -51,11 +53,11 @@ def simple_edit_count(project: str, username: str,
 
 
 def number_of_pages_created(project: str, username: str,
-                            namespace: Optional[str] = None,
-                            redirects: Optional[str] = None,
-                            deleted: Optional[str] = None,
-                            start: Optional[date] = None,
-                            end: Optional[date] = None) -> dict:
+                            namespace: str | None = None,
+                            redirects: str | None = None,
+                            deleted: str | None = None,
+                            start: date | None = None,
+                            end: date | None = None) -> dict[str, Any]:
     """
     Return the number of pages created by a user along with some other info.
 
@@ -99,7 +101,7 @@ def number_of_pages_created(project: str, username: str,
     return base.get(path)
 
 
-def _fix_page(page: dict) -> dict:
+def _fix_page(page: dict[str, Any]) -> dict[str, Any]:
     """
     Fix a page dict as returned by the API.
     :param page:
@@ -113,13 +115,13 @@ def _fix_page(page: dict) -> dict:
 
 
 def pages_created(project: str, username: str,
-                  namespace: str = None,
-                  redirects: Optional[str] = None,
-                  deleted: Optional[str] = None,
-                  start: Optional[date] = None,
-                  end: Optional[date] = None,
-                  offset: Optional[int] = None,
-                  all_times: bool = False) -> dict:
+                  namespace: str | None = None,
+                  redirects: str | None = None,
+                  deleted: str | None = None,
+                  start: date | str | None = None,
+                  end: date | str | None = None,
+                  offset: int | None = None,
+                  all_times: bool = False) -> dict[str, Any]:
     """
     Return pages created by a user. This does not handle pagination; see ``pages_created_iter`` for that.
 
@@ -161,8 +163,8 @@ def pages_created(project: str, username: str,
     :param namespace: one namespace (default is ``"0"``, the main one) or ``"all"`` for all of them.
     :param redirects: either ``"noredirects"`` (default), ``"onlyredirects"``, or ``"all"`` for both.
     :param deleted: either ``"live"``, ``"deleted"``, or ``"all"`` (default).
-    :param start:
-    :param end:
+    :param start: start date. Can be a ``date`` object or a string ``"YYYY-MM-DD"``.
+    :param end: end date. Can be a ``date`` object or a string ``"YYYY-MM-DD"``.
     :param offset:
     :param all_times: if ``True``, fetch all pages instead of the more recent ones. This overrides ``start``
       and ``end``.
@@ -194,10 +196,8 @@ def pages_created(project: str, username: str,
     keys = sorted(pages.keys(), key=int)
 
     is_namespaced = False
-    try:
+    with contextlib.suppress(StopIteration):
         is_namespaced = isinstance(next(pages.values().__iter__()), list)
-    except StopIteration:
-        pass
 
     if is_namespaced:
         ret["pages"] = [_fix_page(page) for k in keys for page in pages[k]]
@@ -208,12 +208,12 @@ def pages_created(project: str, username: str,
 
 
 def pages_created_iter(project: str, username: str,
-                       namespace: str = None,
-                       redirects: Optional[str] = None,
-                       deleted: Optional[str] = None,
-                       start: Optional[date] = None,
-                       end: Optional[date] = None,
-                       all_times: bool = False) -> Generator[dict, None, None]:
+                       namespace: str | None = None,
+                       redirects: str | None = None,
+                       deleted: str | None = None,
+                       start: date | None = None,
+                       end: date | None = None,
+                       all_times: bool = False) -> Generator[dict[str, Any]]:
     """
     Equivalent of ``pages_created`` that yields page dicts and does the pagination for you.
 
@@ -235,23 +235,22 @@ def pages_created_iter(project: str, username: str,
       and ``end``.
     :return:
     """
-    offset = 0
+    offset: int | None = 0
 
     while offset is not None:
         ret = pages_created(project, username,
                             namespace=namespace, redirects=redirects, deleted=deleted,
                             start=start, end=end, all_times=all_times, offset=offset)
         offset = ret.get("continue")
-        for page in ret["pages"]:
-            yield page
+        yield from ret["pages"]
 
 
 def automated_edit_counter(project: str, username: str,
-                           namespace: Optional[str] = None,
-                           start: Optional[date] = None,
-                           end: Optional[date] = None,
-                           offset: Optional[int] = None,
-                           tools: bool = False) -> dict:
+                           namespace: str | None = None,
+                           start: date | None = None,
+                           end: date | None = None,
+                           offset: int | None = None,
+                           tools: bool = False) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/user.html#automated-edit-counter
 
@@ -278,10 +277,10 @@ def automated_edit_counter(project: str, username: str,
     return base.get(path)
 
 
-def _edits(what: str, project: str, username: str, namespace: str = "0",
-           start: Optional[date] = None,
-           end: Optional[date] = None,
-           offset: Optional[int] = None) -> dict:
+def _edits(what: str, project: str, username: str, namespace: str | None = None,
+           start: date | None = None,
+           end: date | None = None,
+           offset: int | None = None) -> dict[str, Any]:
     """
     Base function for both ``non_automated_edits`` and ``automated_edits``.
 
@@ -307,10 +306,10 @@ def _edits(what: str, project: str, username: str, namespace: str = "0",
 
 
 def non_automated_edits(project: str, username: str,
-                        namespace: Optional[str] = None,
-                        start: Optional[date] = None,
-                        end: Optional[date] = None,
-                        offset: Optional[int] = None) -> dict:
+                        namespace: str | None = None,
+                        start: date | None = None,
+                        end: date | None = None,
+                        offset: int | None = None) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/user.html#non-automated-edits
 
@@ -327,10 +326,10 @@ def non_automated_edits(project: str, username: str,
 
 
 def automated_edits(project: str, username: str,
-                    namespace: Optional[str] = None,
-                    start: Optional[date] = None,
-                    end: Optional[date] = None,
-                    offset: Optional[int] = None) -> dict:
+                    namespace: str | None = None,
+                    start: date | None = None,
+                    end: date | None = None,
+                    offset: int | None = None) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/user.html#automated-edits
 
@@ -347,9 +346,9 @@ def automated_edits(project: str, username: str,
 
 
 def edit_summaries(project: str, username: str,
-                   namespace: Optional[str] = None,
-                   start: Optional[date] = None,
-                   end: Optional[date] = None) -> dict:
+                   namespace: str | None = None,
+                   start: date | None = None,
+                   end: date | None = None) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/user.html#edit-summaries
 
@@ -371,8 +370,8 @@ def edit_summaries(project: str, username: str,
 
 
 def top_edits(project: str, username: str,
-              namespace: Optional[str] = None,
-              page_title: Optional[str] = None) -> dict:
+              namespace: str | None = None,
+              page_title: str | None = None) -> dict[str, Any]:
     """
     Return the top-edited pages by a user, or all edits made by a user to a specific page.
 
@@ -395,8 +394,8 @@ def top_edits(project: str, username: str,
 
 
 def category_edit_counter(project: str, username: str, categories: Sequence[str],
-                          start: Optional[date] = None,
-                          end: Optional[date] = None) -> dict:
+                          start: date | None = None,
+                          end: date | None = None) -> dict[str, Any]:
     """
     https://xtools.readthedocs.io/en/stable/api/user.html#category-edit-counter
 
@@ -417,7 +416,7 @@ def category_edit_counter(project: str, username: str, categories: Sequence[str]
     return base.get(path)
 
 
-def log_counts(project: str, username: str) -> dict:
+def log_counts(project: str, username: str) -> dict[str, Any]:
     """
     Return counts of logged actions made by a user.
 
@@ -445,10 +444,10 @@ def log_counts(project: str, username: str) -> dict:
     :param username:
     :return:
     """
-    return base.get("/user/log_counts/%s/%s" % (project, username))
+    return base.get(f"/user/log_counts/{project}/{username}")
 
 
-def namespace_totals(project: str, username: str) -> dict:
+def namespace_totals(project: str, username: str) -> dict[str, Any]:
     """
     Return the edit count for each namespace with at least 1 edit.
 
@@ -458,10 +457,10 @@ def namespace_totals(project: str, username: str) -> dict:
     :param username:
     :return:
     """
-    return base.get("/user/namespace_totals/%s/%s" % (project, username))
+    return base.get(f"/user/namespace_totals/{project}/{username}")
 
 
-def month_counts(project: str, username: str) -> dict:
+def month_counts(project: str, username: str) -> dict[str, Any]:
     """
     Return the edit count of a user, grouped by namespace then year and month.
 
@@ -471,10 +470,10 @@ def month_counts(project: str, username: str) -> dict:
     :param username:
     :return:
     """
-    return base.get("/user/month_counts/%s/%s" % (project, username))
+    return base.get(f"/user/month_counts/{project}/{username}")
 
 
-def time_card(project: str, username: str) -> dict:
+def time_card(project: str, username: str) -> dict[str, Any]:
     """
     Return the relative distribution of edits made by a user based on hour of the day and day of the week.
 
@@ -501,4 +500,4 @@ def time_card(project: str, username: str) -> dict:
     :param username:
     :return:
     """
-    return base.get("/user/timecard/%s/%s" % (project, username))
+    return base.get(f"/user/timecard/{project}/{username}")

xtools-0.1.2/PKG-INFO

@@ -1,42 +0,0 @@
-Metadata-Version: 2.1
-Name: xtools
-Version: 0.1.2
-Summary: XTools API wrapper
-Home-page: https://github.com/bfontaine/xtools
-Author: Baptiste Fontaine
-Author-email: b@ptistefontaine.fr
-License: MIT
-Description: # xtools
-        [![Version on Pypi](https://img.shields.io/pypi/v/xtools.svg?label=PyPI)](https://pypi.org/project/coveralls/)
-        [![Coverage Status](https://coveralls.io/repos/github/bfontaine/xtools/badge.svg?branch=master)](https://coveralls.io/github/bfontaine/xtools?branch=master)
-        
-        **xtools** is a Python wrapper around [XTools][]’ API.
-        
-        [XTools]: https://xtools.readthedocs.io/en/stable/index.html
-        
-        Note this project is not affiliated with nor endorsed by XTools.
-        
-        ## Install
-        
-            pip install xtools
-        
-        ### Requirements
-        
-        Python 3.5+.
-        
-        ## Usage
-        
-        [Read the docs](https://python-xtools.readthedocs.io/en/latest/).
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Software Development
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown

xtools-0.1.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

xtools-0.1.2/setup.py

@@ -1,27 +0,0 @@
-from setuptools import setup
-
-setup(name="xtools",
-      version="0.1.2",
-      author="Baptiste Fontaine",
-      author_email="b@ptistefontaine.fr",
-      description="XTools API wrapper",
-      long_description=open('README.md').read(),
-      long_description_content_type='text/markdown',
-      url="https://github.com/bfontaine/xtools",
-      install_requires=['requests'],
-      license="MIT",
-      packages=['xtools'],
-      # https://pypi.org/pypi?%3Aaction=list_classifiers
-      classifiers=[
-          'Development Status :: 4 - Beta',
-          'Intended Audience :: Developers',
-          'License :: OSI Approved :: MIT License',
-          'Topic :: Software Development',
-          'Programming Language :: Python',
-          'Programming Language :: Python :: 3 :: Only',
-          'Programming Language :: Python :: 3.5',
-          'Programming Language :: Python :: 3.6',
-          'Programming Language :: Python :: 3.7',
-          'Programming Language :: Python :: 3.8',
-          'Operating System :: OS Independent',
-      ])

xtools-0.1.2/xtools/__init__.py

@@ -1,11 +0,0 @@
-from .page import article_info, prose, links, top_editors, assessments
-from .project import (normalize_project, namespaces, page_assessments, page_assessments_configuration, automated_tools,
-                      admins_and_user_groups, admin_statistics, patroller_statistics, steward_statistics)
-from .quote import random_quote, single_quote, all_quotes
-from .user import (simple_edit_count, number_of_pages_created, pages_created, pages_created_iter,
-                   automated_edit_counter,  non_automated_edits, automated_edits,  edit_summaries, top_edits,
-                   category_edit_counter, log_counts, namespace_totals, month_counts, time_card)
-
-from .exceptions import BaseXToolsException, NotFound, TooManyEdits
-
-__version__ = "0.1.2"

xtools-0.1.2/xtools/tests.py

@@ -1,18 +0,0 @@
-"""
-Internal unit-testing utilities.
-"""
-
-import unittest
-
-from xtools import base
-
-TEST_URL_PREFIX = "m://x"
-
-
-class TestCase(unittest.TestCase):
-    def setUp(self):
-        self.base_url = base.BASE_URL
-        setattr(base, "BASE_URL", TEST_URL_PREFIX)
-
-    def tearDown(self):
-        setattr(base, "BASE_URL", self.base_url)

xtools-0.1.2/xtools.egg-info/PKG-INFO

@@ -1,42 +0,0 @@
-Metadata-Version: 2.1
-Name: xtools
-Version: 0.1.2
-Summary: XTools API wrapper
-Home-page: https://github.com/bfontaine/xtools
-Author: Baptiste Fontaine
-Author-email: b@ptistefontaine.fr
-License: MIT
-Description: # xtools
-        [![Version on Pypi](https://img.shields.io/pypi/v/xtools.svg?label=PyPI)](https://pypi.org/project/coveralls/)
-        [![Coverage Status](https://coveralls.io/repos/github/bfontaine/xtools/badge.svg?branch=master)](https://coveralls.io/github/bfontaine/xtools?branch=master)
-        
-        **xtools** is a Python wrapper around [XTools][]’ API.
-        
-        [XTools]: https://xtools.readthedocs.io/en/stable/index.html
-        
-        Note this project is not affiliated with nor endorsed by XTools.
-        
-        ## Install
-        
-            pip install xtools
-        
-        ### Requirements
-        
-        Python 3.5+.
-        
-        ## Usage
-        
-        [Read the docs](https://python-xtools.readthedocs.io/en/latest/).
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Topic :: Software Development
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.5
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Operating System :: OS Independent
-Description-Content-Type: text/markdown

xtools-0.1.2/xtools.egg-info/SOURCES.txt

@@ -1,15 +0,0 @@
-README.md
-setup.py
-xtools/__init__.py
-xtools/base.py
-xtools/exceptions.py
-xtools/page.py
-xtools/project.py
-xtools/quote.py
-xtools/tests.py
-xtools/user.py
-xtools.egg-info/PKG-INFO
-xtools.egg-info/SOURCES.txt
-xtools.egg-info/dependency_links.txt
-xtools.egg-info/requires.txt
-xtools.egg-info/top_level.txt

xtools-0.1.2/xtools.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

xtools-0.1.2/xtools.egg-info/requires.txt

@@ -1 +0,0 @@
-requests

xtools-0.1.2/xtools.egg-info/top_level.txt

@@ -1 +0,0 @@
-xtools