richqueue 0.5__tar.gz → 0.6__tar.gz

{richqueue-0.5 → richqueue-0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: richqueue
-Version: 0.5
+Version: 0.6
 Summary: RichQueue
 Project-URL: Homepage, https://github.com/mwinokan/RichQueue/issues
 Project-URL: Bug Tracker, https://github.com/mwinokan/RichQueue/issues
@@ -16,4 +16,30 @@ Requires-Dist: typer
 Description-Content-Type: text/markdown
 
 # RichQueue
-💰 RichQueue: A colourful and pythonic SLURM queue viewer
+
+> 💰 RichQueue: A colourful and pythonic SLURM queue viewer
+
+Installation from a modern python environment (>3.10) should be as simple as:
+
+```shell
+
+pip install --upgrade richqueue
+```
+
+To see your live-updating SLURM queue:
+
+```shell
+rq
+```
+
+![queue_example](https://github.com/user-attachments/assets/d99ca5e9-7675-4853-ab28-2d7b4da855f2)
+
+## Other options
+
+To see more detail:
+
+```rq --long```
+
+To see someone else's queue:
+
+```rq --user USER```

richqueue-0.6/README.md

@@ -0,0 +1,28 @@
+# RichQueue
+
+> 💰 RichQueue: A colourful and pythonic SLURM queue viewer
+
+Installation from a modern python environment (>3.10) should be as simple as:
+
+```shell
+
+pip install --upgrade richqueue
+```
+
+To see your live-updating SLURM queue:
+
+```shell
+rq
+```
+
+![queue_example](https://github.com/user-attachments/assets/d99ca5e9-7675-4853-ab28-2d7b4da855f2)
+
+## Other options
+
+To see more detail:
+
+```rq --long```
+
+To see someone else's queue:
+
+```rq --user USER```

{richqueue-0.5 → richqueue-0.6}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 [project]
 name = "richqueue"
-version = "0.5"
+version = "0.6"
 authors = [
     { name = "Max Winokan", email = "max@winokan.com" },
 ]

{richqueue-0.5 → richqueue-0.6}/richqueue/slurm.py

@@ -5,6 +5,7 @@ from rich.console import Console
 from rich.panel import Panel
 from rich.layout import Layout
 from pandas import DataFrame
+import subprocess
 
 console = Console()
 
@@ -28,6 +29,16 @@ def color_by_state(state):
     else:
         return state
 
+def color_by_node_state(state):
+
+    if state == "ALLOCATED":
+        return "[orange1]Allocated"
+    elif state == "MIXED":
+        return "[bright_yellow]Mixed"
+    elif state == "IDLE":
+        return "[bright_green]Idle"
+    else:
+        return f"[red]{state}"
 
 def extract_inner(df, key, inner):
 
@@ -71,6 +82,72 @@ def extract_list(df, key):
 
     df[key] = df.apply(inner, axis=1)
 
+def mem_string(mb):
+    
+    # gb, mb = divmod(mb, 1024)
+
+    # return f"{gb}G {mb}M"
+
+    return f"{mb/1024:.0f}G"
+
+def node_table(
+    df,
+    title: str = None,
+    box: bool = False,
+    panel: bool = True,
+    idle: bool = True,
+):
+
+    if idle:
+        df = df[df["node"].isin(["IDLE", "MIXED"])]
+        title = title or "idle nodes" 
+    else:
+        title = title or "nodes"
+
+    from rich.table import Table
+
+    if box:
+        from rich.box import SIMPLE
+
+        box = SIMPLE
+
+    table = Table(title=title, box=box, header_style="")
+
+    table.add_column("[bold underline]Node", justify='left', no_wrap=True, style="bold")
+    table.add_column("[bold underline]State", justify='left', no_wrap=True, style="bold")
+    table.add_column("[green_yellow underline]Partition", justify='left', no_wrap=True, style="green_yellow")
+    table.add_column("[magenta underline]#C", justify='right', no_wrap=True, style="magenta")
+    table.add_column("[magenta underline]Memory", justify='right', no_wrap=True, style="magenta")
+    table.add_column("[dodger_blue2 underline]Features", justify='left', no_wrap=True, style="dodger_blue2")
+
+    reservation = any(df["reservation"].values)
+
+    if reservation:
+        table.add_column("[bold underline]Reservation", justify='left', no_wrap=True, style="bold")
+
+    for i,row in df.iterrows():
+
+        values = []
+
+        values.append(row.nodes)
+        # values.append(row.nodes)
+        values.append(color_by_node_state(row.node))
+        values.append(row.partition)
+        values.append(str(row.cpus_idle))
+        values.append(mem_string(row.memory_free))
+        values.append(row.features)
+
+        if reservation:
+            values.append(row.reservation)
+
+        table.add_row(*values)
+
+        # table.add_row(*[str(v) for v in row.values])
+
+    if panel:
+        return Panel(table, expand=False)
+
+    return table
 
 def job_table(
     df,
@@ -289,11 +366,11 @@ def show_queue(
     user: None | str = None,
     long: bool = False,
     return_table: bool = False,
+    hist: int = 2,
+    hist_unit: str= "weeks",
     box: bool = False,
 ):
 
-    import subprocess
-
     if user == "all":
         user = None
     elif user is None:
@@ -304,7 +381,10 @@ def show_queue(
     if user:
         s_command = f"{command} -u {user} --json"
     else:
-        s_command = f"{command} --json"
+        s_command = f"{command} -u {user} --json"
+
+    if command == "sacct":
+        s_command += f" -S now-{hist}{hist_unit}"
 
     x = subprocess.Popen([s_command], shell=True, stdout=subprocess.PIPE)
     output = x.communicate()
@@ -318,7 +398,7 @@ def show_queue(
     cluster = METADATA["cluster_name"]
 
     if command == "sacct":
-        title = f"[bold]{user}'s history on {cluster}"
+        title = f"[bold]{user}'s previous jobs (last {hist} {hist_unit})"
 
     elif user:
         df = df[df["user_name"] == user]
@@ -366,13 +446,54 @@ def dual_layout(
     else:
         return layout
 
+def parse_sinfo_json(payload: dict) -> "DataFrame":
+
+    df = DataFrame(payload['sinfo'])
+
+    df2 = df.drop(columns=["port", "weight", "disk", "sockets", "threads", "cluster", "comment", "extra", "gres", "reason", "cores"])
+    df2["node"] = df2.apply(lambda x: x["node"]["state"][0], axis=1)
+    df2["nodes"] = df2.apply(lambda x: x["nodes"]["nodes"][0], axis=1)
+    df2["cpus_max"] = df2.apply(lambda x: x["cpus"]["maximum"], axis=1)
+    df2["cpus_idle"] = df2.apply(lambda x: x["cpus"]["idle"], axis=1)
+    df2["cpus_allocated"] = df2.apply(lambda x: x["cpus"]["allocated"], axis=1)
+    df2["memory_max"] = df2.apply(lambda x: x["memory"]["maximum"], axis=1)
+    df2["memory_free"] = df2.apply(lambda x: x["memory"]["free"]["maximum"]["number"], axis=1)
+    df2["memory_allocated"] = df2.apply(lambda x: x["memory"]["allocated"], axis=1)
+    df2["features"] = df2.apply(lambda x: x["features"]["total"], axis=1)
+    df2["partition"] = df2.apply(lambda x: x["partition"]["name"], axis=1)
+
+    df2.drop(columns=["cpus", "memory"], inplace=True)
+
+    return df2
+
+def idle_queue():
+
+    s_command = "sinfo -N --json"
+
+    x = subprocess.Popen([s_command], shell=True, stdout=subprocess.PIPE)
+    output = x.communicate()
+
+    payload = json.loads(output[0])
+
+    df = parse_sinfo_json(payload)
+
+    table = node_table(df)
+
+    console.print(table)
 
 @app.command()
-def show(user: None | str = None, long: bool = False):
+def show(user: None | str = None, long: bool = False, idle: bool = False, hist: int | None = None, hist_unit: str = "weeks"):
 
     loop = True
 
-    if loop:
+    if hist:
+
+        show_queue(user=user, command="sacct", long=long, hist=hist, hist_unit=hist_unit)
+
+    elif idle:
+        idle_queue()
+
+    elif loop:
 
         from rich.live import Live
         import time
@@ -393,7 +514,6 @@ def show(user: None | str = None, long: bool = False):
         # show_queue(command="squeue", user=user, long=long)
         # show_queue(command="sacct", user=user, long=long)
 
-
 def main():
     app()
 

richqueue-0.5/README.md

@@ -1,2 +0,0 @@
-# RichQueue
-💰 RichQueue: A colourful and pythonic SLURM queue viewer