Sort order: PR author, then others

Author: stefanv

github_activity/github_activity.py

@@ -1,4 +1,5 @@
 """Use the GraphQL api to grab issues/PRs that match a query."""
+import dataclasses
 import datetime
 import fnmatch
 import os
@@ -343,6 +344,26 @@ def filter(datum):
     return output
 
 
+@dataclasses.dataclass(slots=True)
+class ContributorSet:
+    """This class represents a sorted set of PR contributor usernames.
+
+    The sorting is special, in that the author is placed first.
+    """
+
+    author: str = ""
+    other: set = dataclasses.field(default_factory=set)
+
+    def add(self, contributor):
+        self.other.add(contributor)
+
+    def __iter__(self):
+        if self.author:
+            yield self.author
+        for item in sorted(self.other - {self.author}):
+            yield item
+
+
 def generate_activity_md(
     target,
     since=None,
@@ -438,7 +459,8 @@ def filter_ignored(userlist):
         return {user for user in userlist if not ignored_user(user)}
 
     for ix, row in data.iterrows():
-        item_contributors = set()
+        # Track contributors to this PR
+        item_contributors = ContributorSet()
 
         # This is a list, since we *want* duplicates in here—they
         # indicate number of times a contributor commented
@@ -450,7 +472,7 @@ def filter_ignored(userlist):
         # - merger
         # - reviewers
 
-        item_contributors.add(row.author)
+        item_contributors.author = row.author
 
         if row.kind == "pr":
             for committer in filter_ignored(row.committers):
@@ -491,7 +513,7 @@ def filter_ignored(userlist):
             all_contributors.add(person)
 
         # record contributor list (ordered, unique)
-        data.at[ix, "contributors"] = sorted(item_contributors)
+        data.at[ix, "contributors"] = list(item_contributors)
 
     comment_contributor_counts = pd.Series(comment_helpers).value_counts()
     all_contributors |= set(

tests/test_cli.py

@@ -127,3 +127,18 @@ def test_cli_ignore_user(tmpdir):
     run(cmd.split(), check=True)
     md = path_output.read_text()
     assert not "@choldgraf" in md
+
+
+def test_contributor_sorting(tmpdir, file_regression):
+    """Test that PR author appears first, then rest of contributors, sorted"""
+    path_tmp = Path(tmpdir)
+    path_output = path_tmp.joinpath("out.md")
+
+    org, repo = ("jupyter-book", "mystmd")
+
+    cmd = (
+        f"github-activity {org}/{repo} -s mystmd@1.5.1 -u mystmd@1.6.0 -o {path_output}"
+    )
+    run(cmd.split(), check=True)
+    md = path_output.read_text()
+    file_regression.check(md, extension=".md")

tests/test_cli/cli_def_branch.md

@@ -5,11 +5,11 @@
 ## New features added
 
 - adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Enhancements made
 
-- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@betatim](https://github.com/betatim), [@choldgraf](https://github.com/choldgraf))
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf), [@betatim](https://github.com/betatim))
 - updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
 - some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
@@ -23,7 +23,7 @@
 
 ## Documentation improvements
 
-- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Contributors to this release
 

tests/test_cli/cli_no_target.md

@@ -5,11 +5,11 @@
 ## New features added
 
 - adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Enhancements made
 
-- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@betatim](https://github.com/betatim), [@choldgraf](https://github.com/choldgraf))
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf), [@betatim](https://github.com/betatim))
 - updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
 - some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
@@ -23,7 +23,7 @@
 
 ## Documentation improvements
 
-- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Contributors to this release
 

tests/test_cli/cli_no_target_pyproject.md

@@ -5,11 +5,11 @@
 ###### New features added
 
 - adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ###### Enhancements made
 
-- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@betatim](https://github.com/betatim), [@choldgraf](https://github.com/choldgraf))
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf), [@betatim](https://github.com/betatim))
 - updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
 - some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
@@ -23,7 +23,7 @@
 
 ###### Documentation improvements
 
-- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ###### Contributors to this release
 

tests/test_cli/cli_w_parts.md

@@ -5,11 +5,11 @@
 ## New features added
 
 - adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Enhancements made
 
-- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@betatim](https://github.com/betatim), [@choldgraf](https://github.com/choldgraf))
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf), [@betatim](https://github.com/betatim))
 - updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
 - some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
@@ -23,7 +23,7 @@
 
 ## Documentation improvements
 
-- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Contributors to this release
 

tests/test_cli/cli_w_url.md

@@ -5,11 +5,11 @@
 ## New features added
 
 - adding contributors list [#10](https://github.com/executablebooks/github-activity/pull/10) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Support git references etc. [#6](https://github.com/executablebooks/github-activity/pull/6) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Enhancements made
 
-- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@betatim](https://github.com/betatim), [@choldgraf](https://github.com/choldgraf))
+- defining contributions [#14](https://github.com/executablebooks/github-activity/pull/14) ([@choldgraf](https://github.com/choldgraf), [@betatim](https://github.com/betatim))
 - updating CLI for new tags [#12](https://github.com/executablebooks/github-activity/pull/12) ([@choldgraf](https://github.com/choldgraf))
 - some improvements to `since` and opened issues list [#8](https://github.com/executablebooks/github-activity/pull/8) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
@@ -23,7 +23,7 @@
 
 ## Documentation improvements
 
-- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Mention the required GITHUB_ACCESS_TOKEN [#1](https://github.com/executablebooks/github-activity/pull/1) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ## Contributors to this release
 

tests/test_cli/test_cli_all.md

@@ -5,18 +5,18 @@
 ### Enhancements made
 
 - Use auth for all usages of requests [#60](https://github.com/executablebooks/github-activity/pull/60) ([@blink1073](https://github.com/blink1073), [@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- Handle detection of target from SSH based remotes [#51](https://github.com/executablebooks/github-activity/pull/51) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- Handle detection of target from SSH based remotes [#51](https://github.com/executablebooks/github-activity/pull/51) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 - ✨ ENH: Auto-detecting the target [#45](https://github.com/executablebooks/github-activity/pull/45) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
 ### Bugs fixed
 
-- 🐛 FIX: write status messages to sys.stderr [#47](https://github.com/executablebooks/github-activity/pull/47) ([@choldgraf](https://github.com/choldgraf), [@minrk](https://github.com/minrk))
+- 🐛 FIX: write status messages to sys.stderr [#47](https://github.com/executablebooks/github-activity/pull/47) ([@minrk](https://github.com/minrk), [@choldgraf](https://github.com/choldgraf))
 
 ### Maintenance and upkeep improvements
 
-- 🔧 MAINT: Split test_cli using @pytest.mark.parameterize [#56](https://github.com/executablebooks/github-activity/pull/56) ([@choldgraf](https://github.com/choldgraf), [@manics](https://github.com/manics))
-- pre-commit configured and executed [#55](https://github.com/executablebooks/github-activity/pull/55) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- 🔧 MAINT: _get_latest_tag should use the remote repo [#52](https://github.com/executablebooks/github-activity/pull/52) ([@consideRatio](https://github.com/consideRatio), [@manics](https://github.com/manics))
+- 🔧 MAINT: Split test_cli using @pytest.mark.parameterize [#56](https://github.com/executablebooks/github-activity/pull/56) ([@manics](https://github.com/manics), [@choldgraf](https://github.com/choldgraf))
+- pre-commit configured and executed [#55](https://github.com/executablebooks/github-activity/pull/55) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
+- 🔧 MAINT: _get_latest_tag should use the remote repo [#52](https://github.com/executablebooks/github-activity/pull/52) ([@manics](https://github.com/manics), [@consideRatio](https://github.com/consideRatio))
 - 🔧 MAINT: hyphen instead of asterisk [#44](https://github.com/executablebooks/github-activity/pull/44) ([@choldgraf](https://github.com/choldgraf))
 
 ### Contributors to this release
@@ -34,23 +34,23 @@ See [our definition of contributors](https://github-activity.readthedocs.io/en/l
 
 ### New features added
 
-- Adding filtering by branch [#42](https://github.com/executablebooks/github-activity/pull/42) ([@blink1073](https://github.com/blink1073), [@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- ✨NEW: heading_level argument for increasing heading level [#38](https://github.com/executablebooks/github-activity/pull/38) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio), [@minrk](https://github.com/minrk))
+- Adding filtering by branch [#42](https://github.com/executablebooks/github-activity/pull/42) ([@choldgraf](https://github.com/choldgraf), [@blink1073](https://github.com/blink1073), [@consideRatio](https://github.com/consideRatio))
+- ✨NEW: heading_level argument for increasing heading level [#38](https://github.com/executablebooks/github-activity/pull/38) ([@minrk](https://github.com/minrk), [@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
 ### Enhancements made
 
-- use tqdm for progress [#39](https://github.com/executablebooks/github-activity/pull/39) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio), [@minrk](https://github.com/minrk))
-- 👌IMPROVE: add blank lines below headings [#36](https://github.com/executablebooks/github-activity/pull/36) ([@choldgraf](https://github.com/choldgraf), [@minrk](https://github.com/minrk))
-- 👌 IMPROVE: since/until: assume git reference, fallback to datetime [#33](https://github.com/executablebooks/github-activity/pull/33) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- use tqdm for progress [#39](https://github.com/executablebooks/github-activity/pull/39) ([@minrk](https://github.com/minrk), [@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- 👌IMPROVE: add blank lines below headings [#36](https://github.com/executablebooks/github-activity/pull/36) ([@minrk](https://github.com/minrk), [@choldgraf](https://github.com/choldgraf))
+- 👌 IMPROVE: since/until: assume git reference, fallback to datetime [#33](https://github.com/executablebooks/github-activity/pull/33) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ### Bugs fixed
 
-- 🐛 FIX: tags like 'doctor' would trigger 'doc' tag [#40](https://github.com/executablebooks/github-activity/pull/40) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
+- 🐛 FIX: tags like 'doctor' would trigger 'doc' tag [#40](https://github.com/executablebooks/github-activity/pull/40) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
 
 ### Maintenance and upkeep improvements
 
-- Remove no longer used code [#37](https://github.com/executablebooks/github-activity/pull/37) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
-- [FIX,TST] resolve refs when not run from a repo [#35](https://github.com/executablebooks/github-activity/pull/35) ([@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio), [@minrk](https://github.com/minrk))
+- Remove no longer used code [#37](https://github.com/executablebooks/github-activity/pull/37) ([@consideRatio](https://github.com/consideRatio), [@choldgraf](https://github.com/choldgraf))
+- [FIX,TST] resolve refs when not run from a repo [#35](https://github.com/executablebooks/github-activity/pull/35) ([@minrk](https://github.com/minrk), [@choldgraf](https://github.com/choldgraf), [@consideRatio](https://github.com/consideRatio))
 
 ### Documentation improvements