gitlogstats 1.2.0__tar.gz → 1.4.0__tar.gz

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: gitlogstats
-Version: 1.2.0
+Version: 1.4.0
 Summary: Track developers' contributions to one or more git repositories within a particular time range.
 Project-URL: Homepage, https://github.com/bloombar/gitlogstats
 Project-URL: Repository, https://github.com/bloombar/gitlogstats.git
@@ -709,7 +709,7 @@ This script calculates the following, for each developer in each repository:
 - number of **files changed**
 - number of **merges** into the analyzed branch
 
-With `--github`, it also reports each developer's GitHub **pull requests** opened, merged, closed without merging and merged by themselves (see [GitHub pull requests](#github-pull-requests)).
+With `--github`, it also reports each developer's GitHub **pull requests** opened, merged, closed without merging and merged by themselves, their **pushes** to the analyzed branch and their commits made on GitHub's **website** (see [GitHub pull requests](#github-pull-requests)).
 
 The results can be formatted as `csv`, `json`, or `markdown`.
 
@@ -752,9 +752,11 @@ options:
   -v, --verbose         Whether to output debugging info
   -c, --clean           Remove contributors without any contribuition
   --github              Also report GitHub pull requests opened, merged,
-                        closed and self-merged per contributor, and match
-                        GitHub users to git authors. Needs the GitHub CLI
-                        (gh), signed in
+                        closed and self-merged per contributor, with their git
+                        and GitHub emails, their pushes to the analyzed branch
+                        and their commits made on the GitHub website, and
+                        match GitHub users to git authors. Needs the GitHub
+                        CLI (gh), signed in
 ```
 
 In case `gitlogstats` is not found as a command, even after installing, try `python -m gitlogstats` or `python3 -m gitlogstats` instead.
@@ -837,7 +839,7 @@ gitlogstats -rf repos.txt -c
 
 ### GitHub pull requests
 
-Add `--github` to also count each contributor's pull requests. Five columns are appended to every output format:
+Add `--github` to also count each contributor's pull requests, pushes and website commits. Nine columns are appended to every output format:
 
 | Column                | Meaning                                                                                                 |
 | --------------------- | ------------------------------------------------------------------------------------------------------- |
@@ -846,6 +848,10 @@ Add `--github` to also count each contributor's pull requests. Five columns are
 | `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too)   |
 | `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                          |
 | `prs_self_merged`     | pull requests they authored and also merged themselves, merged in the date range (also in `prs_merged`) |
+| `git_email`           | every distinct author email of the git names combined into the row, sorted alphabetically (ignoring case) and separated by `; `; empty for a GitHub-only row |
+| `github_email`        | the public email on the matched GitHub profile; empty when the profile has none (GitHub does not reveal private emails) or no account matched |
+| `pushes_to_default`   | times they pushed directly to the analyzed branch (the default branch, or the `-b` branch) in the date range; each push counts once however many commits it carries. Pull request merges, merge-queue merges and creating or deleting branches are not pushes |
+| `web_commits`         | their commits counted in `commits` that were made on GitHub's website (committer `GitHub <noreply@github.com>`), such as editing, creating, deleting or uploading a file in the browser; never more than `commits`. The commit GitHub makes when it squash- or rebase-merges a pull request is not counted |
 
 ```
 gitlogstats -r https://github.com/bloombar/gitlogstats.git --github
@@ -858,7 +864,9 @@ gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install
 gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.
 ```
 
-**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics.
+**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics. When GitHub could not be asked, `git_email` is still filled in and `github_email` is empty. The emails come from the whole history of the branch, not only from commits in the date range.
+
+**Limits of pushes and website commits.** Pushes come from GitHub's repository activity record, which starts in September 2023: earlier pushes are not counted, however old the date range. A file edited on the website directly on the analyzed branch is recorded by GitHub as a push too, so it counts in both `pushes_to_default` and `web_commits`. Reading it works for any public repository you can see; for a private one you need access to it, and if GitHub refuses, the repository's GitHub columns are empty with the reason on standard error, as above. A push is credited to the GitHub user who pushed it, so a person who only pushes (and has no commits or pull requests in the range) still gets a row of their own. Pushes made while a tag or commit (not a branch) is checked out with `-b` are not counted. Website commits are recognised by GitHub being the committer, so commits made through GitHub's API, for example in the `github.dev` editor, are counted as website commits too, and so is the first commit GitHub creates when a repository is created on the website. Website commits follow `commits`: the same date range, exclusions (`-x`) and branch, credited to the commit's author and added up when names are combined into one row.
 
 **Matching GitHub users to git authors.** Each git author name is compared with the GitHub users active in the repository, trying these in order and stopping at the first that finds exactly one user:
 

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/README.md

@@ -12,7 +12,7 @@ This script calculates the following, for each developer in each repository:
 - number of **files changed**
 - number of **merges** into the analyzed branch
 
-With `--github`, it also reports each developer's GitHub **pull requests** opened, merged, closed without merging and merged by themselves (see [GitHub pull requests](#github-pull-requests)).
+With `--github`, it also reports each developer's GitHub **pull requests** opened, merged, closed without merging and merged by themselves, their **pushes** to the analyzed branch and their commits made on GitHub's **website** (see [GitHub pull requests](#github-pull-requests)).
 
 The results can be formatted as `csv`, `json`, or `markdown`.
 
@@ -55,9 +55,11 @@ options:
   -v, --verbose         Whether to output debugging info
   -c, --clean           Remove contributors without any contribuition
   --github              Also report GitHub pull requests opened, merged,
-                        closed and self-merged per contributor, and match
-                        GitHub users to git authors. Needs the GitHub CLI
-                        (gh), signed in
+                        closed and self-merged per contributor, with their git
+                        and GitHub emails, their pushes to the analyzed branch
+                        and their commits made on the GitHub website, and
+                        match GitHub users to git authors. Needs the GitHub
+                        CLI (gh), signed in
 ```
 
 In case `gitlogstats` is not found as a command, even after installing, try `python -m gitlogstats` or `python3 -m gitlogstats` instead.
@@ -140,7 +142,7 @@ gitlogstats -rf repos.txt -c
 
 ### GitHub pull requests
 
-Add `--github` to also count each contributor's pull requests. Five columns are appended to every output format:
+Add `--github` to also count each contributor's pull requests, pushes and website commits. Nine columns are appended to every output format:
 
 | Column                | Meaning                                                                                                 |
 | --------------------- | ------------------------------------------------------------------------------------------------------- |
@@ -149,6 +151,10 @@ Add `--github` to also count each contributor's pull requests. Five columns are
 | `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too)   |
 | `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                          |
 | `prs_self_merged`     | pull requests they authored and also merged themselves, merged in the date range (also in `prs_merged`) |
+| `git_email`           | every distinct author email of the git names combined into the row, sorted alphabetically (ignoring case) and separated by `; `; empty for a GitHub-only row |
+| `github_email`        | the public email on the matched GitHub profile; empty when the profile has none (GitHub does not reveal private emails) or no account matched |
+| `pushes_to_default`   | times they pushed directly to the analyzed branch (the default branch, or the `-b` branch) in the date range; each push counts once however many commits it carries. Pull request merges, merge-queue merges and creating or deleting branches are not pushes |
+| `web_commits`         | their commits counted in `commits` that were made on GitHub's website (committer `GitHub <noreply@github.com>`), such as editing, creating, deleting or uploading a file in the browser; never more than `commits`. The commit GitHub makes when it squash- or rebase-merges a pull request is not counted |
 
 ```
 gitlogstats -r https://github.com/bloombar/gitlogstats.git --github
@@ -161,7 +167,9 @@ gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install
 gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.
 ```
 
-**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics.
+**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics. When GitHub could not be asked, `git_email` is still filled in and `github_email` is empty. The emails come from the whole history of the branch, not only from commits in the date range.
+
+**Limits of pushes and website commits.** Pushes come from GitHub's repository activity record, which starts in September 2023: earlier pushes are not counted, however old the date range. A file edited on the website directly on the analyzed branch is recorded by GitHub as a push too, so it counts in both `pushes_to_default` and `web_commits`. Reading it works for any public repository you can see; for a private one you need access to it, and if GitHub refuses, the repository's GitHub columns are empty with the reason on standard error, as above. A push is credited to the GitHub user who pushed it, so a person who only pushes (and has no commits or pull requests in the range) still gets a row of their own. Pushes made while a tag or commit (not a branch) is checked out with `-b` are not counted. Website commits are recognised by GitHub being the committer, so commits made through GitHub's API, for example in the `github.dev` editor, are counted as website commits too, and so is the first commit GitHub creates when a repository is created on the website. Website commits follow `commits`: the same date range, exclusions (`-x`) and branch, credited to the commit's author and added up when names are combined into one row.
 
 **Matching GitHub users to git authors.** Each git author name is compared with the GitHub users active in the repository, trying these in order and stopping at the first that finds exactly one user:
 

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/docs/SPEC.md

@@ -120,11 +120,29 @@ With `--github`, for each contributor, the number of pull requests they authored
 
 **Status:** Done
 
+#### STAT-13 Contributor email addresses
+
+With `--github`, every row also reports the contributor's email addresses in two columns appended after `prs_self_merged`: `git_email` lists every distinct author email of the git identities combined into the row (STAT-11), sorted alphabetically (ignoring case) and separated by `; `, and is empty for a GitHub-only row; `github_email` is the public email on the matched GitHub user's profile, and is empty when the profile has none (GitHub does not reveal private emails) or the row has no GitHub user. Emails come from the whole history of the analyzed branch, like the contributor list, not only from commits in the date range. When GitHub statistics are unavailable for a repository (CLI-3), `git_email` is still filled in and `github_email` is empty (`null` in JSON). Without `--github`, neither column appears.
+
+**Status:** Done
+
+#### STAT-14 Pushes to the analyzed branch
+
+With `--github`, for each contributor, the number of times they pushed directly to the analyzed branch (the default branch, or the `-b` branch) in the date range, reported in a `pushes_to_default` column appended after `github_email`. Pushes come from GitHub's repository activity record (`repos/{owner}/{repo}/activity`), which names the GitHub user who pushed: activity types `push` and `force_push` count; pull-request merges, merge-queue merges and branch creation or deletion do not. One push counts once however many commits it carries. Each push is filtered by its own timestamp, using the same inclusive local-time range as FILT-1, and credited to the row of the GitHub user who pushed (STAT-11); a GitHub user with pushes but no other row gets a GitHub-only row. GitHub's activity record does not go back before September 2023, so older pushes are not counted. Without `-b`, the branch is the default branch; if the clone is on no branch (a tag or commit was checked out), no pushes are counted. GitHub lets anyone who can see a public repository read its activity record; a private repository needs access to it.
+
+**Status:** Done
+
+#### STAT-15 Commits made on the GitHub website
+
+With `--github`, for each contributor, how many of their commits counted in `commits` (STAT-1: same date range, exclusions and branch, merges excluded) were made on GitHub's website rather than in a local clone, reported in a `web_commits` column appended after `pushes_to_default`, so `web_commits` is never larger than `commits`. A commit counts when GitHub created it — its committer is `GitHub <noreply@github.com>` — and it is not the result of merging a pull request: a commit GitHub created when squash- or rebase-merging a pull request is not a website commit. Such a commit is the merge commit GitHub names for a merged pull request, or was committed within 2 seconds of one (the other commits of a rebase merge); GitHub commits the result a few seconds before it marks the pull request merged, so the pull request's merge time is used only when GitHub names no merge commit. A named merge commit committed more than a minute before or after the merge time is the pull request's own head commit, which reached the branch another way, so that pull request excludes nothing. A commit GitHub created when a repository was created on the website (a root commit) counts like any other. Such commits are typically file edits, creations, deletions and uploads made in the browser; commits made through GitHub's API (e.g. `github.dev`) look the same and are counted too. Website commits are credited to the commit's author, like `commits`, and summed when identities are combined (STAT-11). When GitHub statistics are unavailable for a repository (CLI-3), `pushes_to_default` and `web_commits` are empty (`null` in JSON).
+
+**Status:** Done
+
 ### 3. Filtering
 
 #### FILT-1 Date range
 
-`-s/--start` and `-e/--end` (format `mm/dd/yyyy`) limit the analysis to commits whose commit date falls between the start of the start date and the end of the end date, inclusive, in local time. Defaults: one year ago until today. The output records the requested start and end dates on every row. With `--github`, each pull request count is filtered by its own timestamp in the same range (CLI-3).
+`-s/--start` and `-e/--end` (format `mm/dd/yyyy`) limit the analysis to commits whose commit date falls between the start of the start date and the end of the end date, inclusive, in local time. Defaults: one year ago until today. The output records the requested start and end dates on every row. With `--github`, each pull request and push count is filtered by its own timestamp in the same range (CLI-3).
 
 **Status:** Done
 
@@ -142,7 +160,7 @@ With `--github`, for each contributor, the number of pull requests they authored
 
 #### FILT-4 Remove inactive contributors
 
-By default, contributors with no activity in the date range are listed with zeros. `-c/--clean` removes them. With `--github`, only rows with neither git nor pull-request activity are removed (CLI-3).
+By default, contributors with no activity in the date range are listed with zeros. `-c/--clean` removes them. With `--github`, only rows with neither git, pull-request nor push activity are removed (CLI-3).
 
 **Status:** Done
 
@@ -150,7 +168,7 @@ By default, contributors with no activity in the date range are listed with zero
 
 #### OUT-1 CSV output
 
-`-f csv` (the default) prints a header row followed by one row per contributor per repository, with fields `username, repository, start_date, end_date, commits, insertions, deletions, files, merges`. New fields are added at the end so existing column positions do not change. Values containing commas, quotes or line breaks are quoted. The header is printed even when there are no rows, and the output ends with a single newline. With `--github`, the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged` are appended, and are in the header even when there are no rows (CLI-3).
+`-f csv` (the default) prints a header row followed by one row per contributor per repository, with fields `username, repository, start_date, end_date, commits, insertions, deletions, files, merges`. New fields are added at the end so existing column positions do not change. Values containing commas, quotes or line breaks are quoted. The header is printed even when there are no rows, and the output ends with a single newline. With `--github`, the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged, git_email, github_email, pushes_to_default, web_commits` are appended, and are in the header even when there are no rows (CLI-3).
 
 **Status:** Done
 
@@ -194,12 +212,12 @@ Invalid dates, and a start date after the end date, are rejected with a usage er
 
 #### CLI-3 GitHub pull-request statistics
 
-`--github` adds GitHub pull-request statistics (STAT-8 to STAT-12) for repositories hosted on github.com, appending the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged` to every output format. Without `--github`, the output and behaviour are unchanged, GitHub is never contacted and the GitHub CLI (`gh`) is not needed. With `--github`, the GitHub API is called through `gh api`, so `gh` must be installed and signed in. This is checked before any repository is cloned; if it fails, nothing is printed to standard output, the tool exits with status 1, and one plain message on standard error says why and what to do — no stack trace:
+`--github` adds GitHub pull-request statistics (STAT-8 to STAT-12), contributor emails (STAT-13), pushes to the analyzed branch (STAT-14) and website commits (STAT-15) for repositories hosted on github.com, appending the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged, git_email, github_email, pushes_to_default, web_commits` to every output format. Without `--github`, the output and behaviour are unchanged, GitHub is never contacted and the GitHub CLI (`gh`) is not needed. With `--github`, the GitHub API is called through `gh api`, so `gh` must be installed and signed in. This is checked before any repository is cloned; if it fails, nothing is printed to standard output, the tool exits with status 1, and one plain message on standard error says why and what to do — no stack trace:
 
 - `gh` not found: `gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install it from https://cli.github.com and run 'gh auth login', or run without --github.`
 - `gh` not signed in (`gh auth status` fails): `gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.`
 
-The other options apply to pull requests as follows: `-s/-e` filter each count by its own timestamp, using the same inclusive local-time range as FILT-1; `-u` selects the combined row whose author names, emails or GitHub username match exactly (the username ignoring case); `-b` counts only pull requests whose base branch is that branch, and without `-b` every pull request counts; `-c` removes only rows with neither git nor pull-request activity; `-x` does not apply. For a repository not on github.com, or when GitHub cannot be reached for one repository (no network, rate limit, private repository without access), the git statistics are still reported, the five GitHub columns are empty (`null` in JSON) rather than zero, and the reason is printed to standard error.
+The other options apply to pull requests as follows: `-s/-e` filter each count by its own timestamp, using the same inclusive local-time range as FILT-1; `-u` selects the combined row whose author names, emails or GitHub username match exactly (the username ignoring case); `-b` counts only pull requests whose base branch is that branch, and without `-b` every pull request counts; `-c` removes only rows with neither git, pull-request nor push activity; `-x` does not apply to pull requests or pushes (it limits which commits count as website commits, as it does for `commits`); `-b` also selects the branch whose pushes are counted. For a repository not on github.com, or when GitHub cannot be reached for one repository (no network, rate limit, private repository without access), the git statistics are still reported, the GitHub columns (including `github_email`, `pushes_to_default` and `web_commits`) are empty (`null` in JSON) rather than zero while `git_email` is still filled in (STAT-13), and the reason is printed to standard error.
 
 **Status:** Done
 

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "gitlogstats"
 description = "Track developers' contributions to one or more git repositories within a particular time range."
-version = "1.2.0"
+version = "1.4.0"
 authors = [
   { name="Tobody Tothing", email="nobody.nothing@nowhere.com" },
 ]

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/scripts/board/manifest.yaml

@@ -19,16 +19,16 @@
   status: Done
 - id: CLI-3
   title: GitHub pull-request statistics
-  full: "--github adds GitHub pull-request statistics (STAT-8 to STAT-12) for
-    repositories hosted on github.com, appending the columns github_username,
-    prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged to every output
-    format. Without --github, the output and behaviour are unchanged, GitHub is
-    never contacted and the GitHub CLI (gh) is not needed. With --github, the
-    GitHub API is called through gh api, so gh must be installed and signed in.
-    This is checked before any repository is cloned; if it fails, nothing is
-    printed to standard output, the tool exits with status 1, and one plain
-    message on standard error says why and what to do — no stack trace: gh not
-    found: gitlogstats: --github…"
+  full: --github adds GitHub pull-request statistics (STAT-8 to STAT-12),
+    contributor emails (STAT-13), pushes to the analyzed branch (STAT-14) and
+    website commits (STAT-15) for repositories hosted on github.com, appending
+    the columns github_username, prs_opened, prs_merged, prs_closed_unmerged,
+    prs_self_merged, git_email, github_email, pushes_to_default, web_commits to
+    every output format. Without --github, the output and behaviour are
+    unchanged, GitHub is never contacted and the GitHub CLI (gh) is not needed.
+    With --github, the GitHub API is called through gh api, so gh must be
+    installed and signed in. This is checked before any repository is cloned; if
+    it fails, nothing is printed to standard…
   section: §5 Command-Line Interface
   family: CLI
   phase: 1
@@ -39,8 +39,8 @@
     whose commit date falls between the start of the start date and the end of
     the end date, inclusive, in local time. Defaults: one year ago until today.
     The output records the requested start and end dates on every row. With
-    --github, each pull request count is filtered by its own timestamp in the
-    same range (CLI-3)."
+    --github, each pull request and push count is filtered by its own timestamp
+    in the same range (CLI-3)."
   section: §3 Filtering
   family: FILT
   phase: 1
@@ -75,7 +75,7 @@
   title: Remove inactive contributors
   full: By default, contributors with no activity in the date range are listed
     with zeros. -c/--clean removes them. With --github, only rows with neither
-    git nor pull-request activity are removed (CLI-3).
+    git, pull-request nor push activity are removed (CLI-3).
   section: §3 Filtering
   family: FILT
   phase: 1
@@ -89,8 +89,9 @@
     containing commas, quotes or line breaks are quoted. The header is printed
     even when there are no rows, and the output ends with a single newline. With
     --github, the columns github_username, prs_opened, prs_merged,
-    prs_closed_unmerged, prs_self_merged are appended, and are in the header
-    even when there are no rows (CLI-3).
+    prs_closed_unmerged, prs_self_merged, git_email, github_email,
+    pushes_to_default, web_commits are appended, and are in the header even when
+    there are no rows (CLI-3).
   section: §4 Output
   family: OUT
   phase: 1
@@ -348,6 +349,54 @@
   family: STAT
   phase: 1
   status: Done
+- id: STAT-13
+  title: Contributor email addresses
+  full: "With --github, every row also reports the contributor's email addresses
+    in two columns appended after prs_self_merged: git_email lists every
+    distinct author email of the git identities combined into the row (STAT-11),
+    sorted alphabetically (ignoring case) and separated by ; , and is empty for
+    a GitHub-only row; github_email is the public email on the matched GitHub
+    user's profile, and is empty when the profile has none (GitHub does not
+    reveal private emails) or the row has no GitHub user. Emails come from the
+    whole history of the analyzed branch, like the contributor list, not only
+    from commits in the date range. When GitHub statistics are unavailable for a
+    repository (CLI-3), git_email is…"
+  section: §2 Contribution Statistics
+  family: STAT
+  phase: 1
+  status: Done
+- id: STAT-14
+  title: Pushes to the analyzed branch
+  full: "With --github, for each contributor, the number of times they pushed
+    directly to the analyzed branch (the default branch, or the -b branch) in
+    the date range, reported in a pushes_to_default column appended after
+    github_email. Pushes come from GitHub's repository activity record
+    (repos/{owner}/{repo}/activity), which names the GitHub user who pushed:
+    activity types push and force_push count; pull-request merges, merge-queue
+    merges and branch creation or deletion do not. One push counts once however
+    many commits it carries. Each push is filtered by its own timestamp, using
+    the same inclusive local-time range as FILT-1, and credited to the row of
+    the GitHub user who pushed (STAT-11); a GitHub…"
+  section: §2 Contribution Statistics
+  family: STAT
+  phase: 1
+  status: Done
+- id: STAT-15
+  title: Commits made on the GitHub website
+  full: "With --github, for each contributor, how many of their commits counted in
+    commits (STAT-1: same date range, exclusions and branch, merges excluded)
+    were made on GitHub's website rather than in a local clone, reported in a
+    web_commits column appended after pushes_to_default, so web_commits is never
+    larger than commits. A commit counts when GitHub created it — its committer
+    is GitHub <noreply@github.com> — and it is not the result of merging a pull
+    request: a commit GitHub created when squash- or rebase-merging a pull
+    request is not a website commit. Such a commit is the merge commit GitHub
+    names for a merged pull request, or was committed within 2 seconds of one
+    (the other commits of a…"
+  section: §2 Contribution Statistics
+  family: STAT
+  phase: 1
+  status: Done
 - id: FUTURE-author-date-filtering
   title: Author-date filtering
   full: Author-date filtering — offer filtering by author date, so rebased or

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/src/gitlogstats/__main__.py

@@ -6,7 +6,13 @@ import re
 import sys
 from . import GitLogsParser
 from .git_logs_parser import FIELDNAMES
-from .github import GITHUB_FIELDNAMES, GitHubUnavailable, check_gh
+from .github import (
+    ACTIVITY_FIELDNAMES,
+    EMAIL_FIELDNAMES,
+    GITHUB_FIELDNAMES,
+    GitHubUnavailable,
+    check_gh,
+)
 from .github_stats import github_rows
 
 
@@ -142,7 +148,9 @@ def main():
     parser.add_argument(
         "--github",
         help="Also report GitHub pull requests opened, merged, closed and "
-        "self-merged per contributor, and match GitHub users to git authors. "
+        "self-merged per contributor, with their git and GitHub emails, their "
+        "pushes to the analyzed branch and their commits made on the GitHub "
+        "website, and match GitHub users to git authors. "
         "Needs the GitHub CLI (gh), signed in",
         default=False,
         action="store_true",
@@ -233,7 +241,11 @@ def main():
     # emit a single table (or JSON array) covering all repositories
     if last_parser is not None:
         # an empty CSV table still gets the GitHub columns with --github
-        fieldnames = FIELDNAMES + GITHUB_FIELDNAMES if args.github else None
+        fieldnames = (
+            FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES + ACTIVITY_FIELDNAMES
+            if args.github
+            else None
+        )
         output = last_parser.format_results(all_results, args.format, fieldnames)
         # end with exactly one newline: CSV and Markdown output already has one
         print(output, end="" if output.endswith("\n") else "\n")

{gitlogstats-1.2.0 → gitlogstats-1.4.0}/src/gitlogstats/git_logs_parser.py

@@ -21,6 +21,11 @@ FILES_RE = re.compile(r"(\d+) files? changed")
 INSERTIONS_RE = re.compile(r"(\d+) insertions?\(\+\)")
 DELETIONS_RE = re.compile(r"(\d+) deletions?\(-\)")
 
+# STAT-15: the header of each commit when listing who committed it and when
+COMMITTER_LOG_FORMAT = (
+    f"--format={RECORD_SEP}%H{FIELD_SEP}%aN{FIELD_SEP}%aE{FIELD_SEP}%cE{FIELD_SEP}%ct"
+)
+
 # the fields reported for each contributor, in output order
 FIELDNAMES = [
     "username",
@@ -128,11 +133,13 @@ class GitLogsParser:
             f"--until={until:%Y-%m-%d %H:%M:%S}",
         ]
 
-    def git_log_command(self):
+    def git_log_command(self, log_format=LOG_FORMAT, shortstat=True):
         """
         Build the git log command that lists every non-merge commit in the date
         range with its author and a one-line summary of its changes. Merge
         commits come from merge_log_command instead.
+        @param log_format: the --format argument
+        @param shortstat: whether to add the summary of changes
         @returns: the command as a list of arguments, ready for subprocess
         """
         # --full-history stops git from hiding commits while simplifying the
@@ -142,8 +149,8 @@ class GitLogsParser:
             "log",
             "--full-history",
             "--no-merges",
-            "--shortstat",
-            LOG_FORMAT,
+            *(["--shortstat"] if shortstat else []),
+            log_format,
             *self.date_range_args(),
             "--",
             ".",
@@ -185,6 +192,44 @@ class GitLogsParser:
             *self.date_range_args(),
         ]
 
+    def current_branch(self):
+        """
+        Name the branch checked out in the repository.
+        @returns: the branch name, or None if HEAD is detached
+        """
+        result = subprocess.run(
+            ["git", "symbolic-ref", "--short", "-q", "HEAD"], capture_output=True
+        )
+        if result.returncode != 0:
+            return None
+        return result.stdout.decode("utf-8", errors="replace").strip()
+
+    def committed_commits(self):
+        """
+        STAT-15: list the commits counted in `commits` (STAT-1: the same date
+        range, exclusions and branch, merges left out) with their committers.
+        @returns: a list of dicts with hash, name (author), email (author),
+            committer_email and committed (committer time, epoch seconds)
+        """
+        cmd = self.git_log_command(COMMITTER_LOG_FORMAT, shortstat=False)
+        self.verboseprint(f"Running command: {' '.join(cmd)}")
+        result = subprocess.run(cmd, capture_output=True, check=True)
+        commits = []
+        for record in result.stdout.decode("utf-8", errors="replace").split(RECORD_SEP)[
+            1:
+        ]:
+            fields = record.strip("\n").split(FIELD_SEP)
+            commits.append(
+                {
+                    "hash": fields[0],
+                    "name": fields[1],
+                    "email": fields[2],
+                    "committer_email": fields[3],
+                    "committed": int(fields[4]),
+                }
+            )
+        return commits
+
     def run_git_log(self, cmd):
         """
         Run a git log command and parse its output into per-commit records.