about summary refs log tree commit diff
path: root/tools/gha-billing
diff options
context:
space:
mode:
authorFranck Cuny <franck@fcuny.net>2022-10-31 11:29:11 -0700
committerFranck Cuny <franck@fcuny.net>2022-10-31 11:29:11 -0700
commit4dd250dc04e8c44fa91627fb051a9670b7b01e63 (patch)
tree03ef67d6ff1b1f10096bf2b58795214fc5e17819 /tools/gha-billing
parentref(home/python): install a few more packages (diff)
downloadworld-4dd250dc04e8c44fa91627fb051a9670b7b01e63.tar.gz
feat(tools/gha-billing): a CLI to report minutes left/used on GHA
Diffstat (limited to '')
-rw-r--r--tools/gha-billing/default.nix35
-rwxr-xr-xtools/gha-billing/gha-billing.py40
2 files changed, 75 insertions, 0 deletions
diff --git a/tools/gha-billing/default.nix b/tools/gha-billing/default.nix
new file mode 100644
index 0000000..51f69f8
--- /dev/null
+++ b/tools/gha-billing/default.nix
@@ -0,0 +1,35 @@
+{ self, lib, stdenvNoCC, pkgs }:
+
+stdenvNoCC.mkDerivation rec {
+  pname = "gha-billing";
+  src = ./gha-billing.py;
+  version = "0.1.0";
+
+  buildInputs = [
+    (pkgs.python310.withPackages (ps: with ps; [
+      requests
+    ]))
+  ];
+
+  propagatedBuildInputs = [
+    (pkgs.python310.withPackages (ps: with ps; [
+      requests
+    ]))
+  ];
+
+  dontUnpack = true;
+  dontBuild = true;
+
+  installPhase = ''
+    mkdir -p $out/bin
+    cp $src $out/bin/${pname}
+  '';
+
+
+  meta = with pkgs.lib; {
+    description = "CLI to get billing information for GHA.";
+    license = licenses.mit;
+    platforms = platforms.unix;
+    maintainers = [ ];
+  };
+}
diff --git a/tools/gha-billing/gha-billing.py b/tools/gha-billing/gha-billing.py
new file mode 100755
index 0000000..c9c09ba
--- /dev/null
+++ b/tools/gha-billing/gha-billing.py
@@ -0,0 +1,40 @@
+#!/usr/bin/env python3
+
+import argparse
+import os
+import sys
+
+import requests
+
+API_URL = "https://api.github.com"
+
+
+def main(api_token: str, user: str) -> None:
+    s = requests.Session()
+    s.headers.update({"Authorization": f"token {api_token}"})
+    s.headers.update({"Accept": "application/vnd.github.v3+json"})
+
+    res = s.get(f"{API_URL}/users/{user}/settings/billing/actions", timeout=5)
+    res.raise_for_status()
+
+    billing = res.json()
+
+    time_remaining = billing["included_minutes"] - billing["total_minutes_used"]
+    print(
+        f"this cycle, {billing['total_minutes_used']} minutes have been used, and {time_remaining} minutes are remaining"
+    )
+
+
+if __name__ == "__main__":
+    argp = argparse.ArgumentParser()
+    argp.add_argument("-t", "--token-file", nargs=1, type=argparse.FileType("r"))
+    argp.add_argument("-u", "--user", type=str, default="fcuny")
+    args = argp.parse_args()
+
+    if args.token_file:
+        api_token = args.token_file[0].readline().strip()
+    else:
+        print("Must pass token file with -t/--token_file", file=sys.stderr)
+        sys.exit(os.EX_USAGE)
+
+    main(api_token, args.user)