Merge branch 'main' into dependabot/pip/fastcore-1.8.2

Signed-off-by: Roger Barker <roger.barker@swirldslabs.com>

Author: rbarker-dev

README.md

@@ -1,40 +1,53 @@
 ![App icon](images/FullSizeIcon.png)
 
 # VersionTwo
+
 Hackathon project: CLI tool to generate static planning view of issues for better team planning
 
-# 🚀 Getting Started
-## 📦 Requirements
+## 🚀 Getting Started
+
+### 📦 Requirements
+
 The following dependencies are required to run the program:
+
 - Python 3.x
   - `brew install python3`
 - Python `pyenv` and `pyenv-virtualenv`
-  -  `brew install pyenv pyenv-virtualenv`
+  - `brew install pyenv pyenv-virtualenv`
 - GitHub Command Line Interface (CLI) `gh`
   - `brew install gh`
 
-## 💻 Setup
+### 💻 Setup
+
 - Authentication through `gh auth login`
-- Set the appropriate token permissions: `gh auth refresh --scopes read:project`
-  - Note: The team must have `read` permissions on the Project Board in order to view the issues on the board.
-- Set the `GITHUB_TOKEN` environment variable: `export GITHUB_TOKEN=$(gh auth token)`
-- Set the `GITHUB_UNAME` environment variable: `export GITHUB_UNAME=$(gh auth status | grep "(GITHUB_TOKEN)" | cut -d " " -f9)`
+- Source the [setup-gh.sh](src/setup-gh.sh) script to configure your gh environment variables
+  
+  ```bash
+    source src/setup-gh.sh # follow the prompts
+  ```
+
+  - Sets the appropriate token scopes: `read: project`.
+    - Note: The team must have `read` permissions on the Project Board in order to view the issues on the board.
+  - Sets the `GITHUB_TOKEN` environment variable.
+  - Sets the `GITHUB_UNAME` environment variable.
 - Run `make install` inside the repo directory to configure the appropriate versions of dependencies.
 
-## 🛠 Usage
+### 🛠 Usage
+
 To run the main script, change to the current directory of the script, then run:
 
 `python version2.py --output-file "<filename.json>" --temp-dir "<temp.dir>" --include-project <project name>`
 
 See the `--help` menu for full list of filter functionality.
 
-# Background
+## Background
+
 GitHub users have issues assigned to themselves or a team they are a member of. These issues can be viewed on a 
 Project board, which captures the issues in swim lanes. The Project board can only automate with a single organization,
 meaning users who work in more than one org do not have a single location to view all issues. This leads to fragmented
 planning and execution.
 
-# How does it work?
+## How does it work?
 
 ```mermaid
 %% A · System-Architecture Diagram (≤25 nodes)
@@ -52,7 +65,8 @@ classDef api fill:#e3f2fd,stroke:#2196f3;
 classDef cli fill:#f1f8e9,stroke:#7cb342;
 ```
 
-# Our Solution
+## Our Solution
+
 Our python script will query the GitHub API for all issues associated with the appropriate filters provided to the CLI
 tool. The output will be a static HTML page showing all issues in swim lanes. This provides a comprehensive overview
-of all issues the team or user has assigned. 
+of all issues the team or user has assigned.

requirements.txt

@@ -1,5 +1,5 @@
 certifi==2025.4.26
-charset-normalizer==3.4.1
+charset-normalizer==3.4.2
 fastcore==1.8.2
 ghapi==1.0.6
 idna==3.10

src/setup-gh.sh

@@ -0,0 +1,43 @@
+#! /usr/bin/env bash
+
+# This script sets up the authentication parameters for the GitHub CLI
+# that are needed to run the version2.py script.
+# It is assumed that the GitHub CLI is already installed and configured
+# on the system.
+# The script will update the user's github token to have the needed scopes,
+# set the token in the environment and pull in the gh users username as
+# another environment variable.
+
+# Exit if not sourced
+if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then
+  echo "ERROR: This script must be sourced, not executed."
+  echo "Usage: source ${BASH_SOURCE[0]}"
+  exit 1
+fi
+
+# Check if the GITHUB_TOKEN environment variable is already set
+set_gh_token() {
+    # If not set, set the scopes for the token and set the environment variable
+    gh auth refresh --scopes read:project
+
+    # Set the GITHUB_TOKEN environment variable
+    export GITHUB_TOKEN=$(gh auth token)
+}
+
+configure_gh_env() {
+    if [ -n "${GITHUB_TOKEN}" ]; then
+        echo "GITHUB_TOKEN needs to be unset to update the token scopes."
+        unset GITHUB_TOKEN
+    fi
+
+    # set the gh_token
+    set_gh_token
+
+    # set the gh_user
+    export GITHUB_UNAME=$(gh api user --jq .login)
+
+    echo "GITHUB_TOKEN is set. Length is: ${#GITHUB_TOKEN}"
+    echo "GITHUB_UNAME is set to: ${GITHUB_UNAME}"
+}
+
+configure_gh_env

src/static_site_generator.py

@@ -15,7 +15,7 @@ def __init__(self):
             'tasks': []
         }
 
-    def generate_site(self, data:list=None, projects:list[str]=None, output_file='./_site/index.html') -> None:
+    def generate_site(self, data:list=None, filter_done:bool=False, projects:list[str]=None, output_file='./_site/index.html') -> None:
         logging.info("Generating Static Site")
         env = Environment(loader=FileSystemLoader('templates'))
         template = env.get_template('kaban_board.html')
@@ -34,9 +34,14 @@ def generate_site(self, data:list=None, projects:list[str]=None, output_file='./
         for task in self.GENERATOR_DATA["tasks"]:
             if "status" not in task:
               task["status"] = "NONE"
+            elif task["status"].upper() == "DONE" and filter_done == True:
+                # remove the task from the list
+                self.GENERATOR_DATA["tasks"].remove(task)
+                continue
             else:
               task["status"] = task["status"].upper()
             statuses.add(task["status"])
+        print(f"[bold cyan]Adding {len(self.GENERATOR_DATA["tasks"])} tasks to the site[/bold cyan]")
 
         # Extract unique statuses from the tasks list
         unique_statuses:list[str] = sorted(statuses)

src/version2config.py

@@ -37,6 +37,13 @@ def init_parser(self):
           help="The temporary directory to store the json data files"
         )
 
+        parser.add_argument(
+            "--filter-done",
+            dest="filter_done",
+            action="store_true",
+            help="Filter out all issues and PRs that are marked as done"
+        )
+
         parser.add_argument(
             "--include-project",
             dest="include_project",
@@ -176,6 +183,7 @@ def init_parser(self):
         self.exclude_label = parsed_args.exclude_label
         self.publish_board = parsed_args.publish_board
         self.exclude_team = parsed_args.exclude_team
+        self.filter_done = parsed_args.filter_done if parsed_args.filter_done else False
 
     def init_logger(self):
         logging.basicConfig(level=self.LOG_LEVEL, format=self.LOG_FORMAT)
@@ -187,6 +195,7 @@ def display_config(self):
         logging.info("Configuration:")
         logging.info(f"Output File: {self.output_file}")
         logging.info(f"Temporary Directory: {self.temp_dir}")
+        logging.info(f"Filter Done: {self.filter_done}")
         logging.info(f"Include Project: {self.include_project}")
         logging.info(f"Include User: {self.include_user}")
         logging.info(f"Include Repository: {self.include_repository}")

src/version2query.py

@@ -7,6 +7,7 @@
 from pathlib import Path
 from ghapi.all import GhApi
 from rich import print
+from time import sleep
 from .queryFilter import QueryFilter
 
 class Version2Query:
@@ -130,7 +131,9 @@ def fetch_project_items(self, projects:list[dict]) -> bool:
       # use os.system instead of subprocess.run or subprocess.popen to avoid creating a new
       # process space where we would need to copy environment variables into it (possibly
       # exposing things like GH_TOKEN or other environment variables)
-      os.system( f'gh project item-list --owner "{org}" {number} --format json > "{out_path}"')
+      # The default limit on the gh project item-list command is 30 items. We need to update
+      # the limit to 1000 to get all items in the project.
+      os.system( f'gh project item-list --owner "{org}" {number} --limit 1000 --format json > "{out_path}"')
 
       if not out_path.exists():
           print(f"[red]Failed to fetch items for project: {title} (Org: {org}, Project: {number})[/red]")
@@ -148,6 +151,7 @@ def consolidate_items(self) -> bool:
         with open(file) as f:
           data = json.load(f)
           items = data.get("items", [])
+          print(f"[green]Found {len(items)} items in {file}[/green]")
           all_items.extend(items)
     except Exception as e:
       print(f"[red]Error consolidating items: {e}[/red]")

version2.py

@@ -46,7 +46,7 @@ def main():
     with open(output_file, 'r') as f:
       data = json.load(f)
 
-    ss_gen.generate_site(data=data, projects=filters["include_projects"])
+    ss_gen.generate_site(data=data, filter_done=config.filter_done, projects=filters["include_projects"])
 
 if __name__ == "__main__":
     main()