Release v0.3.0 (#477)

MatthewMiddlehurst · web-flow · commit 4248080f942f · 2023-06-10T11:48:21.000+01:00
* release prep

* changelog 08/06

* remove noqa

* changelog
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -60,5 +60,3 @@ repos:
       - id: pydocstyle
         args: ["--config=setup.cfg"]
         exclude: "tests/__init__.py"
-
-exclude: "build_tools/.*"
diff --git a/README.md b/README.md
@@ -13,7 +13,8 @@ We strive to provide a broad library of time series algorithms including the
 latest advances, offer efficient implementations using numba, and interfaces with other
 time series packages to provide a single framework for algorithm comparison.
 
-The latest `aeon` release is `v0.2.0`. You can view the full changelog [here](https://www.aeon-toolkit.org/en/latest/changelog.html).
+The latest `aeon` release is `v0.3.0`. You can view the full changelog
+[here](https://www.aeon-toolkit.org/en/latest/changelog.html).
 
 ```diff
 - The deprecation policy is currently suspended, be careful with the version bounds used when including aeon as a dependency.
diff --git a/aeon/__init__.py b/aeon/__init__.py
@@ -1,8 +1,7 @@
 # -*- coding: utf-8 -*-
-
 """aeon."""
 
-__version__ = "0.2.0"
+__version__ = "0.3.0"
 
 __all__ = ["show_versions"]
 
diff --git a/build_tools/changelog.py b/build_tools/changelog.py
@@ -2,8 +2,8 @@
 """Myst Markdown changelog generator."""
 
 import os
-from collections import defaultdict
-from typing import Dict, List
+from collections import OrderedDict
+from typing import Dict, List, Tuple
 
 import httpx
 from dateutil import parser
@@ -12,15 +12,14 @@
     "Accept": "application/vnd.github.v3+json",
 }
 
-if os.getenv("GITHUB_TOKEN") is not None:
-    HEADERS["Authorization"] = f"token {os.getenv('GITHUB_TOKEN')}"
-
 OWNER = "aeon-toolkit"
 REPO = "aeon"
 GITHUB_REPOS = "https://api.github.com/repos"
+EXCLUDED_USERS = ["github-actions[bot]"]
 
-def fetch_merged_pull_requests(page: int = 1) -> List[Dict]:  # noqa
-    """Fetch a page of pull requests"""
+
+def fetch_merged_pull_requests(page: int = 1) -> List[Dict]:
+    """Fetch a page of pull requests."""
     params = {
         "base": "main",
         "state": "closed",
@@ -37,7 +36,8 @@ def fetch_merged_pull_requests(page: int = 1) -> List[Dict]:  # noqa
     return [pr for pr in r.json() if pr["merged_at"]]
 
 
-def fetch_latest_release():  # noqa
+def fetch_latest_release() -> Dict:
+    """Fetch latest release."""
     response = httpx.get(
         f"{GITHUB_REPOS}/{OWNER}/{REPO}/releases/latest", headers=HEADERS
     )
@@ -48,11 +48,11 @@ def fetch_latest_release():  # noqa
         raise ValueError(response.text, response.status_code)
 
 
-def fetch_pull_requests_since_last_release() -> List[Dict]:  # noqa
-    """Fetch pull requests and filter based on merged date"""
+def fetch_pull_requests_since_last_release() -> List[Dict]:
+    """Fetch pull requests and filter based on merged date."""
     release = fetch_latest_release()
     published_at = parser.parse(release["published_at"])
-    print(  # noqa
+    print(  # noqa: T201
         f"Latest release {release['tag_name']} was published at {published_at}"
     )
 
@@ -64,13 +64,16 @@ def fetch_pull_requests_since_last_release() -> List[Dict]:  # noqa
         all_pulls.extend(
             [p for p in pulls if parser.parse(p["merged_at"]) > published_at]
         )
-        is_exhausted = any(parser.parse(p["merged_at"]) < published_at for p in pulls) or len(pulls) == 0
+        is_exhausted = (
+            any(parser.parse(p["merged_at"]) < published_at for p in pulls)
+            or len(pulls) == 0
+        )
         page += 1
     return all_pulls
 
 
-def github_compare_tags(tag_left: str, tag_right: str = "HEAD"):  # noqa
-    """Compare commit between two tags"""
+def github_compare_tags(tag_left: str, tag_right: str = "HEAD") -> Dict:
+    """Compare commit between two tags."""
     response = httpx.get(
         f"{GITHUB_REPOS}/{OWNER}/{REPO}/compare/{tag_left}...{tag_right}"
     )
@@ -80,87 +83,156 @@ def github_compare_tags(tag_left: str, tag_right: str = "HEAD"):  # noqa
         raise ValueError(response.text, response.status_code)
 
 
-EXCLUDED_USERS = ["github-actions[bot]"]
-
-def render_contributors(prs: List, fmt: str = "myst"):  # noqa
-    """Find unique authors and print a list in  given format"""
+def render_contributors(prs: list, fmt: str = "myst", n_prs: int = -1):
+    """Find unique authors and print a list in  given format."""
     authors = sorted({pr["user"]["login"] for pr in prs}, key=lambda x: x.lower())
 
     header = "Contributors\n"
     if fmt == "github":
-        print(f"### {header}")  # noqa
-        print(", ".join(f"@{user}" for user in authors if user not in EXCLUDED_USERS))  # noqa
+        print(f"### {header}")  # noqa: T201
+        print(  # noqa: T201
+            ", ".join(f"@{user}" for user in authors if user not in EXCLUDED_USERS)
+        )
     elif fmt == "myst":
-        print(f"## {header}")  # noqa
-        print(",\n".join("{user}" + f"`{user}`" for user in authors if user not in EXCLUDED_USERS))  # noqa
+        print(f"## {header}")  # noqa: T201
+        print(  # noqa: T201
+            "The following have contributed to this release through a collective "
+            f"{n_prs} GitHub Pull Requests:\n"
+        )
+        print(  # noqa: T201
+            ",\n".join(
+                "{user}" + f"`{user}`" for user in authors if user not in EXCLUDED_USERS
+            )
+        )
+
+
+def assign_pr_category(
+    assigned: Dict, categories: List[List], pr_idx: int, pr_labels: List, pkg_title: str
+):
+    """Assign a PR to a category."""
+    has_category = False
+    for cat in categories:
+        if not set(cat[1]).isdisjoint(set(pr_labels)):
+            has_category = True
+
+            if cat[0] not in assigned[pkg_title]:
+                assigned[pkg_title][cat[0]] = []
+
+            assigned[pkg_title][cat[0]].append(pr_idx)
+
+    if not has_category:
+        if "Other" not in assigned[pkg_title]:
+            assigned[pkg_title]["Other"] = []
 
+        assigned[pkg_title]["Other"].append(pr_idx)
 
-def assign_prs(prs, categs: List[Dict[str, List[str]]]):  # noqa
-    """Assign PR to categories based on labels"""
-    assigned = defaultdict(list)
+
+def assign_prs(
+    prs: List[Dict], packages: List[List], categories: List[List]
+) -> Tuple[Dict, int]:
+    """Assign all PRs to packages and categories based on labels."""
+    assigned = {}
+    prs_removed = 0
 
     for i, pr in enumerate(prs):
-        for cat in categs:
-            pr_labels = [label["name"] for label in pr["labels"]]
-            if cat["title"] != "Not Included" and "no changelog" in pr_labels:
-                continue
-            if not set(cat["labels"]).isdisjoint(set(pr_labels)):
-                assigned[cat["title"]].append(i)
-
-    assigned["Other"] = list(
-        set(range(len(prs))) - {i for _, l in assigned.items() for i in l}
-    )
+        pr_labels = [label["name"] for label in pr["labels"]]
+
+        if "no changelog" in pr_labels:
+            prs_removed += 1
+            continue
+
+        has_package = False
+        for pkg in packages:
+            if not set(pkg[1]).isdisjoint(set(pr_labels)):
+                has_package = True
+
+                if pkg[0] not in assigned:
+                    assigned[pkg[0]] = {}
+
+                assign_pr_category(assigned, categories, i, pr_labels, pkg[0])
+
+        if not has_package:
+            if "Other" not in assigned:
+                assigned["Other"] = OrderedDict()
 
-    if "Not Included" in assigned:
-        assigned.pop("Not Included")
+            assign_pr_category(assigned, categories, i, pr_labels, "Other")
 
-    return assigned
+    # order assignments
+    assigned = OrderedDict({k: v for k, v in sorted(assigned.items())})
+    if "Other" in assigned:
+        assigned.move_to_end("Other")
 
+    for key in assigned:
+        assigned[key] = OrderedDict({k: v for k, v in sorted(assigned[key].items())})
+        if "Other" in assigned[key]:
+            assigned[key].move_to_end("Other")
 
-def render_row(pr):  # noqa
+    return assigned, prs_removed
+
+
+def render_row(pr: Dict):  # noqa
     """Render a single row with PR in Myst Markdown format"""
-    print(  # noqa
+    print(  # noqa: T201
         "-",
         pr["title"],
         "({pr}" + f"`{pr['number']}`)",
         "{user}" + f"`{pr['user']['login']}`",
     )
 
 
-def render_changelog(prs, assigned):  # noqa
-    # sourcery skip: use-named-expression
-    """Render changelog"""
-    for title, _ in assigned.items():
-        pr_group = [prs[i] for i in assigned[title]]
-        if pr_group:
-            print(f"\n## {title}\n")  # noqa
+def render_changelog(prs: List[Dict], assigned: Dict):
+    """Render changelog."""
+    for pkg_title, group in assigned.items():
+        print(f"\n## {pkg_title}")  # noqa: T201
+
+        for cat_title, pr_idx in group.items():
+            print(f"\n### {cat_title}\n")  # noqa: T201
+            pr_group = [prs[i] for i in pr_idx]
 
             for pr in sorted(pr_group, key=lambda x: parser.parse(x["merged_at"])):
                 render_row(pr)
 
 
 if __name__ == "__main__":
+    # don't commit the actual token, it will get revoked!
+    os.environ["GITHUB_TOKEN"] = ""
+
+    if os.getenv("GITHUB_TOKEN") is not None and os.getenv("GITHUB_TOKEN") != "":
+        HEADERS["Authorization"] = f"token {os.getenv('GITHUB_TOKEN')}"
+
+    # if you edit these, consider editing the PR template as well
+    packages = [
+        ["Annotation", ["annotation"]],
+        ["Benchmarking", ["benchmarking"]],
+        ["Classification", ["classification"]],
+        ["Clustering", ["clustering"]],
+        ["Distances", ["distances"]],
+        ["Forecasting", ["forecasting"]],
+        ["Regression", ["regression"]],
+        ["Transformations", ["transformations"]],
+    ]
     categories = [
-        {"title": "Enhancements", "labels": ["enhancement"]},
-        {"title": "Fixes", "labels": ["bug"]},
-        {"title": "Maintenance", "labels": ["maintenance"]},
-        {"title": "Refactored", "labels": ["refactor"]},
-        {"title": "Documentation", "labels": ["documentation"]},
-        {"title": "Not Included", "labels": ["no changelog"]},  # this is deleted
+        ["Bug Fixes", ["bug"]],
+        ["Documentation", ["documentation"]],
+        ["Enhancements", ["enhancement"]],
+        ["Maintenance", ["maintenance"]],
+        ["Refactored", ["refactor"]],
     ]
 
     pulls = fetch_pull_requests_since_last_release()
-    print(f"Found {len(pulls)} merged PRs since last release")  # noqa
-    assigned = assign_prs(pulls, categories)
+    print(f"Found {len(pulls)} merged PRs since last release")  # noqa: T201
+
+    assigned, prs_removed = assign_prs(pulls, packages, categories)
+
     render_changelog(pulls, assigned)
-    print()  # noqa
-    render_contributors(pulls)
+    print()  # noqa: T201
+    render_contributors(pulls, fmt="myst", n_prs=len(pulls) - prs_removed)
 
     release = fetch_latest_release()
     diff = github_compare_tags(release["tag_name"])
     if diff["total_commits"] != len(pulls):
         raise ValueError(
             "Something went wrong and not all PR were fetched. "
-            f'There are {len(pulls)} PRs but {diff["total_commits"]} in the diff. '
+            f"There are {len(pulls)} PRs but {diff['total_commits']} in the diff. "
             "Please verify that all PRs are included in the changelog."
-        )  # noqa
+        )
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,10 +1,18 @@
 # Changelog
 
-All notable changes to this project will be documented in this file. We keep track of changes in this file since v0.4.0. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and we adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html>). The source code for all [releases](https://github.com/aeon-toolkit/aeon/releases>) is available on GitHub.
+All notable changes to this project will be documented in this file. The format is
+based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and we adhere
+to [Semantic Versioning](https://semver.org/spec/v2.0.0.html>). The source code for
+all [releases](https://github.com/aeon-toolkit/aeon/releases>) is available on GitHub.
 
-To stay up-to-date with aeon releases, subscribe to aeon [here](https://libraries.io/pypi/aeon>) or follow us on [Twitter](https://twitter.com/aeon_toolbox>).
+To stay up-to-date with aeon releases, subscribe to aeon
+[here](https://libraries.io/pypi/aeon>) or follow us on
+[Twitter](https://twitter.com/aeon_toolbox>).
 
-For upcoming changes and next releases, see our [milestones](https://github.com/aeon-toolkit/aeon/milestones). For our long-term plan, see our [roadmap](roadmap).
+For upcoming changes and next releases, see our
+[milestones](https://github.com/aeon-toolkit/aeon/milestones). For our long-term plan,
+see our [roadmap](roadmap).
 
+- [Version 0.3.0](changelogs/v0.3.md)
 - [Version 0.2.0](changelogs/v0.2.md)
 - [Version 0.1.0](changelogs/v0.1.md)
diff --git a/docs/changelogs/v0.2.md b/docs/changelogs/v0.2.md
@@ -95,7 +95,6 @@ Following this release the deprecation policy remains suspended. Future releases
 - [MNT] Remove any reference of pykalman ({pr}`380`) {user}`hadifawaz1999`
 - [MNT] Unstable extras ({pr}`365`) {user}`MatthewMiddlehurst`
 - [MNT] Remove the test_methods_have_no_side_effects for inceptionTime classifier from _config ({pr}`338`) {user}`hadifawaz1999`
-- [MNT] Cleanup the forecasting tests ({pr}`192`) {user}`lmmentel`
 
 ## Contributors
 
diff --git a/docs/changelogs/v0.3.md b/docs/changelogs/v0.3.md
diff --git a/pyproject.toml b/pyproject.toml
