Attempt org stats

Author: sarahsturgeon

README.md

@@ -96,6 +96,11 @@ For more information on inaccuracies, see issue
      [main
      workflow](https://github.com/jstrieb/github-stats/blob/master/.github/workflows/main.yml))
      called `EXCLUDE_FORKED_REPOS` with a value of `true`.
+   - To generate statistics for a GitHub organization, add a new secret called
+     `GITHUB_ORG` with the name of the organization. Note that when this is set,
+     the statistics will be for the organization and not the user. Also, the
+     `total_contributions`, `lines_changed`, and `views` statistics are not
+     displayed for organizations.
    - These other values are added as secrets by default to prevent leaking
      information about private repositories. If you're not worried about that,
      you can change the values directly [in the Actions workflow

generate_images.py

@@ -38,10 +38,17 @@ async def generate_overview(s: Stats) -> None:
     output = re.sub("{{ name }}", await s.name, output)
     output = re.sub("{{ stars }}", f"{await s.stargazers:,}", output)
     output = re.sub("{{ forks }}", f"{await s.forks:,}", output)
-    output = re.sub("{{ contributions }}", f"{await s.total_contributions:,}", output)
-    changed = (await s.lines_changed)[0] + (await s.lines_changed)[1]
-    output = re.sub("{{ lines_changed }}", f"{changed:,}", output)
-    output = re.sub("{{ views }}", f"{await s.views:,}", output)
+    
+    # Conditional replacement for organization stats
+    if s.org_name:
+        output = re.sub(r"{{ contributions }}", "", output)
+        output = re.sub(r"{{ lines_changed }}", "", output)
+        output = re.sub(r"{{ views }}", "", output)
+    else:
+        output = re.sub("{{ contributions }}", f"{await s.total_contributions:,}", output)
+        changed = (await s.lines_changed)[0] + (await s.lines_changed)[1]
+        output = re.sub("{{ lines_changed }}", f"{changed:,}", output)
+        output = re.sub("{{ views }}", f"{await s.views:,}", output)
     output = re.sub("{{ repos }}", f"{len(await s.repos):,}", output)
 
     generate_output_folder()
@@ -106,6 +113,7 @@ async def main() -> None:
     user = os.getenv("GITHUB_ACTOR")
     if user is None:
         raise RuntimeError("Environment variable GITHUB_ACTOR must be set.")
+    org = os.getenv("GITHUB_ORG")
     exclude_repos = os.getenv("EXCLUDED")
     excluded_repos = (
         {x.strip() for x in exclude_repos.split(",")} if exclude_repos else None
@@ -128,6 +136,7 @@ async def main() -> None:
             exclude_repos=excluded_repos,
             exclude_langs=excluded_langs,
             ignore_forked_repos=ignore_forked_repos,
+            org_name=org,
         )
         await asyncio.gather(generate_languages(s), generate_overview(s))
 

github_stats.py

@@ -250,6 +250,52 @@ def repos_overview(
     }}
   }}
 }}
+"""
+
+    @staticmethod
+    def repos_overview_org(
+        org_name: str, owned_cursor: Optional[str] = None
+    ) -> str:
+        """
+        :param org_name: GitHub organization name
+        :param owned_cursor: GraphQL cursor for pagination
+        :return: GraphQL query with overview of organization repositories
+        """
+        return f"""query {{
+  organization(login: "{org_name}") {{
+    login,
+    name,
+    repositories(
+        first: 100,
+        orderBy: {{
+            field: UPDATED_AT,
+            direction: DESC
+        }},
+        after: {"null" if owned_cursor is None else '"'+ owned_cursor +'"'}
+    ) {{
+      pageInfo {{
+        hasNextPage
+        endCursor
+      }}
+      nodes {{
+        nameWithOwner
+        stargazers {{
+          totalCount
+        }}
+        forkCount
+        languages(first: 10, orderBy: {{field: SIZE, direction: DESC}}) {{
+          edges {{
+            size
+            node {{
+              name
+              color
+            }}
+          }}
+        }}
+      }}
+    }}
+  }}
+}}
 """
 
     @staticmethod
@@ -317,6 +363,7 @@ def __init__(
         cache_ttl: int = 3600,
         include_views: bool = True,
         include_lines_changed: bool = True,
+        org_name: Optional[str] = None,
     ):
         self.username = username
         self._ignore_forked_repos = ignore_forked_repos
@@ -326,6 +373,7 @@ def __init__(
         self._include_lines_changed = include_lines_changed
         self.queries = Queries(username, access_token, session)
         self.cache = SimpleCache(ttl=cache_ttl) if enable_cache else None
+        self.org_name = org_name
 
         self._name: Optional[str] = None
         self._stargazers: Optional[int] = None
@@ -371,29 +419,52 @@ async def get_stats(self) -> None:
         next_owned = None
         next_contrib = None
         while True:
-            raw_results = await self.queries.query(
-                Queries.repos_overview(
-                    owned_cursor=next_owned, contrib_cursor=next_contrib
+            if self.org_name:
+                raw_results = await self.queries.query(
+                    Queries.repos_overview_org(
+                        org_name=self.org_name, owned_cursor=next_owned
+                    )
+                )
+            else:
+                raw_results = await self.queries.query(
+                    Queries.repos_overview(
+                        owned_cursor=next_owned, contrib_cursor=next_contrib
+                    )
                 )
-            )
             raw_results = raw_results if raw_results is not None else {}
 
-            self._name = raw_results.get("data", {}).get("viewer", {}).get("name", None)
-            if self._name is None:
-                self._name = (
+            if self.org_name:
+                self._name = raw_results.get("data", {}).get("organization", {}).get("name", None)
+                if self._name is None:
+                    self._name = (
+                        raw_results.get("data", {})
+                        .get("organization", {})
+                        .get("login", "No Name")
+                    )
+                
+                owned_repos = (
                     raw_results.get("data", {})
-                    .get("viewer", {})
-                    .get("login", "No Name")
+                    .get("organization", {})
+                    .get("repositories", {})
                 )
+                contrib_repos = {}
+            else:
+                self._name = raw_results.get("data", {}).get("viewer", {}).get("name", None)
+                if self._name is None:
+                    self._name = (
+                        raw_results.get("data", {})
+                        .get("viewer", {})
+                        .get("login", "No Name")
+                    )
 
-            contrib_repos = (
-                raw_results.get("data", {})
-                .get("viewer", {})
-                .get("repositoriesContributedTo", {})
-            )
-            owned_repos = (
-                raw_results.get("data", {}).get("viewer", {}).get("repositories", {})
-            )
+                contrib_repos = (
+                    raw_results.get("data", {})
+                    .get("viewer", {})
+                    .get("repositoriesContributedTo", {})
+                )
+                owned_repos = (
+                    raw_results.get("data", {}).get("viewer", {}).get("repositories", {})
+                )
 
             repos = owned_repos.get("nodes", [])
             if not self._ignore_forked_repos:
@@ -424,7 +495,16 @@ async def get_stats(self) -> None:
                             "color": lang.get("node", {}).get("color"),
                         }
 
-            if owned_repos.get("pageInfo", {}).get(
+            if self.org_name:
+                if owned_repos.get("pageInfo", {}).get(
+                    "hasNextPage", False
+                ):
+                    next_owned = owned_repos.get("pageInfo", {}).get(
+                        "endCursor", next_owned
+                    )
+                else:
+                    break
+            elif owned_repos.get("pageInfo", {}).get(
                 "hasNextPage", False
             ) or contrib_repos.get("pageInfo", {}).get("hasNextPage", False):
                 next_owned = owned_repos.get("pageInfo", {}).get(
@@ -515,6 +595,8 @@ async def total_contributions(self) -> int:
         """
         if self._total_contributions is not None:
             return self._total_contributions
+        if self.org_name:
+            return 0
 
         # Check cache first
         cache_key = f"total_contributions_{self.username}"