make cli

Author: cunla

.gitignore

@@ -1,2 +1,3 @@
 .idea
-venv
+.venv
+dist

README.md

@@ -1,7 +1,8 @@
-GitHub Actions Utils
+GitHub Actions CLI
 ====================
 
 The purpose of this tool is to work with your GitHub Actions workflows in your repositories.
+It is complementary to the GitHub CLI.
 
 So far, three main flows are supported:
 
@@ -10,7 +11,7 @@ So far, three main flows are supported:
 Example:
 
 ```shell
-python ghautils.py cunla/fakeredis list-workflows
+github-actions-cli cunla/fakeredis list-workflows
 ```
 will return:
 
@@ -27,7 +28,7 @@ Given a repo and a workflow path, return all actions in the workflow.
 
 Example:
 ```shell
-python ghautils.py cunla/fakeredis list-actions .github/workflows/publish.yml
+github-actions-cli cunla/fakeredis list-actions .github/workflows/publish.yml
 ```
 
 Result
@@ -42,7 +43,7 @@ Show the latest versions of actions used in a repository workflow.
 
 Example:
 ```shell
-python ghautils.py cunla/fakeredis update
+github-actions-cli cunla/fakeredis update
 ```
 Result:
 ```text
@@ -56,10 +57,16 @@ Result:
   actions/checkout @ v3         ==> v3.5.3
 ```
 
+# Installation
+
+```shell
+pip install github-actions-cli
+```
+
 # Help messages
 
 ```text
-usage: ghautils.py [-h] [--github-token GITHUB_TOKEN] repo {list-workflows,list-actions,update} ...
+usage: github-actions-cli [-h] [--github-token GITHUB_TOKEN] repo {list-workflows,list-actions,update} ...
 
 positional arguments:
   repo                  Repository to analyze

gha-cli/__init__.py gha_cli/__init__.pygha-cli/__init__.py renamed to gha_cli/__init__.py

@@ -1,10 +1,16 @@
+#!/usr/bin/env python3
 import argparse
+import logging
 import os
 from typing import Optional, List, Set, Tuple, Dict
 
 import yaml
 from github import Github, Workflow
 
+logging.basicConfig(level=logging.WARNING)
+logging.getLogger('github.Requester').setLevel(logging.WARNING)
+logger = logging.getLogger()
+
 
 def parse_args() -> argparse.Namespace:
     parser = argparse.ArgumentParser()
@@ -14,8 +20,8 @@ def parse_args() -> argparse.Namespace:
         help='GitHub token to use, by default will use GITHUB_TOKEN environment variable')
     subcommands = parser.add_subparsers(dest='command', required=True)
     list_wfs_cmd_parser = subcommands.add_parser('list-workflows', help='List github workflows')
-    list_wfs_cmd_parser.add_argument('--local-only', action='store_true', dest='local_only',
-                                     help='Show only workflows stored in the repository')
+    list_wfs_cmd_parser.add_argument('--all', action='store_true', dest='external_workflows',
+                                     help='Show external workflows as well')
     list_actions_cmd_parser = subcommands.add_parser('list-actions', help='List actions in a workflow')
     list_actions_cmd_parser.add_argument('workflow_path', help='Workflow path')
     update_gha_cmd_parser = subcommands.add_parser('update', help='Update actions in github workflows')
@@ -33,12 +39,12 @@ def __init__(self, github_token: Optional[str]):
             raise ValueError('GITHUB_TOKEN must be set')
         self.client = Github(login_or_token=github_token)
 
-    def get_github_workflows(self, repo_name: str, local_only: bool = False) -> List[Workflow]:
+    def get_github_workflows(self, repo_name: str, external_workflows: bool = False) -> List[Workflow]:
         if repo_name in self.workflows:
             return list(self.workflows[repo_name].values())
         repo = self.client.get_repo(repo_name)
         workflows = list(repo.get_workflows())
-        if local_only:
+        if not external_workflows:
             workflows = list(filter(lambda item: item.path.startswith('.github/'), workflows))
         self.workflows[repo_name] = {wf.path: wf for wf in workflows}
         return workflows

gha-cli/ghautils.py gha_cli/cli.pygha-cli/ghautils.py renamed to gha_cli/cli.py

@@ -2,15 +2,19 @@
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
 
+[tool.poetry.scripts]
+github-actions-cli = "gha_cli.cli:run"
+
 [tool.poetry]
 name = "github-actions-cli"
-packages = [
-    { include = "gha-cli" },
-]
-version = "1.0.0b1"
+version = "1.0.0b2"
 description = "GitHub Actions CLI - allows updating workflows, etc."
 readme = "README.md"
 keywords = ["GitHub Actions", "CLI"]
+packages = [
+    { include = "gha_cli" },
+]
+
 authors = [
     "Daniel Moran <daniel@moransoftware.ca>",
 ]
@@ -39,7 +43,7 @@ documentation = "https://github.com/dsoftwareinc/github-actions-cli"
 [tool.poetry.dependencies]
 python = "^3.9"
 pygithub = "^1.59"
-pyyaml = { version = "^6.0", optional = true }
+pyyaml = "^6.0"
 
 [tool.poetry.dev-dependencies]
 poetry = "^1.5"