richqueue 1.10__tar.gz → 1.11__tar.gz

richqueue-1.11/PKG-INFO

@@ -0,0 +1,116 @@
+Metadata-Version: 2.4
+Name: richqueue
+Version: 1.11
+Summary: RichQueue
+Project-URL: Homepage, https://github.com/mwinokan/RichQueue/issues
+Project-URL: Bug Tracker, https://github.com/mwinokan/RichQueue/issues
+Author-email: Max Winokan <max@winokan.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: pandas
+Requires-Dist: rich
+Requires-Dist: typer
+Description-Content-Type: text/markdown
+
+# 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 `rq` options
+
+To see more detail:
+
+```rq --long```
+
+To see someone else's queue:
+
+```rq --user USER```
+
+To see the last `X` weeks history:
+
+```rq --hist X```
+
+To see history for a given time period, e.g.:
+
+```rq --hist '3 days'```
+
+To list available nodes on the cluster:
+
+```rq --idle```
+
+To show a static view:
+
+```rq --no-loop```
+
+## Monitoring log files
+
+If you keep your SLURM log files in a specific directory exported as the `LOGS` variable, you can use RichQueue to monitor results as they come in with
+
+```
+res <JOB_ID>
+```
+
+<img width="569" height="737" alt="Screenshot 2025-11-20 at 09 05 48" src="https://github.com/user-attachments/assets/1b0f6457-d769-4a1a-b331-bb7f121b5864" />
+
+## Changing to the working directory of a job
+
+To change to the submission/working directory of a job:
+
+```
+cd $(res --dir <JOB_ID>)
+```
+
+You might find it convenient to add a shortcut to this to your login profile, e.g. `.bashrc_user` or `.bash_profile`:
+
+```
+res --install-jd >> ~/.bashrc_user
+source ~/.bashrc_user
+```
+
+This will make the `jd` executable available. Change to the directory of the single active or most recently submitted job:
+
+```
+jd
+```
+
+Change to a specific job's directory:
+
+```
+jd <JOB_ID>
+```
+
+## Submitting SLURM jobs
+
+RichQueue also provides a convenient wrapper to the `sbatch` command which makes sure your log files end up in the directory specified by the `LOGS` variable, and prints a pretty summary of the submitted job. Just replace `sbatch` with `sb`. E.g.:
+
+```
+sb --job-name test script.sh --script-arg1
+```
+
+Would run this under the hood:
+
+```
+sbatch --output=$LOGS/%j.log --error=$LOGS/%j.log --job-name test script.sh --script-arg1
+```
+
+and display the following:
+
+<img width="474" height="255" alt="Screenshot 2025-11-20 at 10 37 19" src="https://github.com/user-attachments/assets/4464f813-841a-45bd-864e-00dd3dabf924" />

richqueue-1.11/README.md

@@ -0,0 +1,99 @@
+# 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 `rq` options
+
+To see more detail:
+
+```rq --long```
+
+To see someone else's queue:
+
+```rq --user USER```
+
+To see the last `X` weeks history:
+
+```rq --hist X```
+
+To see history for a given time period, e.g.:
+
+```rq --hist '3 days'```
+
+To list available nodes on the cluster:
+
+```rq --idle```
+
+To show a static view:
+
+```rq --no-loop```
+
+## Monitoring log files
+
+If you keep your SLURM log files in a specific directory exported as the `LOGS` variable, you can use RichQueue to monitor results as they come in with
+
+```
+res <JOB_ID>
+```
+
+<img width="569" height="737" alt="Screenshot 2025-11-20 at 09 05 48" src="https://github.com/user-attachments/assets/1b0f6457-d769-4a1a-b331-bb7f121b5864" />
+
+## Changing to the working directory of a job
+
+To change to the submission/working directory of a job:
+
+```
+cd $(res --dir <JOB_ID>)
+```
+
+You might find it convenient to add a shortcut to this to your login profile, e.g. `.bashrc_user` or `.bash_profile`:
+
+```
+res --install-jd >> ~/.bashrc_user
+source ~/.bashrc_user
+```
+
+This will make the `jd` executable available. Change to the directory of the single active or most recently submitted job:
+
+```
+jd
+```
+
+Change to a specific job's directory:
+
+```
+jd <JOB_ID>
+```
+
+## Submitting SLURM jobs
+
+RichQueue also provides a convenient wrapper to the `sbatch` command which makes sure your log files end up in the directory specified by the `LOGS` variable, and prints a pretty summary of the submitted job. Just replace `sbatch` with `sb`. E.g.:
+
+```
+sb --job-name test script.sh --script-arg1
+```
+
+Would run this under the hood:
+
+```
+sbatch --output=$LOGS/%j.log --error=$LOGS/%j.log --job-name test script.sh --script-arg1
+```
+
+and display the following:
+
+<img width="474" height="255" alt="Screenshot 2025-11-20 at 10 37 19" src="https://github.com/user-attachments/assets/4464f813-841a-45bd-864e-00dd3dabf924" />

{richqueue-1.10 → richqueue-1.11}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 [project]
 name = "richqueue"
-version = "1.10"
+version = "1.11"
 authors = [
     { name = "Max Winokan", email = "max@winokan.com" },
 ]
@@ -32,3 +32,4 @@ include = [
 [project.scripts]
 rq = "richqueue.main:main"
 res = "richqueue.log:main"
+sb = "richqueue.submit:main"

richqueue-1.11/richqueue/job.py

@@ -0,0 +1,59 @@
+from .slurm import combined_df
+
+
+def guess_current_job(user: str, **kwargs):
+
+    global JOB_DF
+    JOB_DF = combined_df(user=user, **kwargs)
+
+    assert len(JOB_DF), "No jobs found"
+
+    pending = JOB_DF[JOB_DF["job_state"] == "PENDING"]
+    running = JOB_DF[JOB_DF["job_state"] == "RUNNING"]
+    history = JOB_DF[~JOB_DF["job_state"].isin(["PENDING", "RUNNING"])]
+
+    # pick the single active job
+    if len(running) == 1:
+        return running.iloc[0]
+
+    # pick the most recently submitted active job
+    elif len(running) > 1:
+        return running.sort_values(by="submit_time", ascending=False).iloc[0]
+
+    # pick the single pending job
+    elif len(pending) == 1:
+        return pending.iloc[0]
+
+    # pick the most recently submitted pending job
+    elif len(pending) > 1:
+        return pending.sort_values(by="submit_time", ascending=False).iloc[0]
+
+    # pick the most recently submitted pending job
+    else:
+        return pending.sort_values(by="submit_time", ascending=False).iloc[0]
+
+    return job
+
+
+def get_specific_job(job: int, user: str, **kwargs):
+
+    global JOB_DF
+    JOB_DF = combined_df(user=user, **kwargs)
+
+    assert len(JOB_DF), "No jobs found"
+
+    matches = JOB_DF[JOB_DF["job_id"] == job]
+
+    if not len(matches):
+        console.print("[red bold]Could not find job with ID {job_id=}")
+        return None
+
+    elif len(matches) > 1:
+
+        matches = matches[matches["command"].notna()]
+
+        if len(matches) > 1:
+            console.print(matches.to_dict(orient="records"))
+            raise ValueError("Multiple job matches")
+
+    return matches.iloc[0]

{richqueue-1.10 → richqueue-1.11}/richqueue/log.py

@@ -1,3 +1,4 @@
+import sys
 import time
 
 from rich.live import Live
@@ -9,9 +10,10 @@ from typer import Typer, Argument, Option
 
 from .console import console
 from .layout import dual_layout
-from .slurm import combined_df, get_user, PANEL_PADDING
+from .slurm import get_user, PANEL_PADDING
 from .table import job_table, log_table
 from .tools import curry
+from .job import guess_current_job, get_specific_job
 
 # access logs
 
@@ -31,12 +33,27 @@ def show_log(
             help="Query jobs for another user",
         ),
     ] = None,
-    long: Annotated[bool, Option("-v", "--long", help="More detailed output")] = False,
-    wisdom: Annotated[
-        bool, Option("-w", "--wisdom", help="Show a confucius quote on exit")
+    cwd: Annotated[
+        bool,
+        Option("-d", "--dir", help="Print job's current working directory and exit"),
+    ] = False,
+    install_jd: Annotated[
+        bool, Option("--install-jd", help="Print function to create jd wrapper")
     ] = False,
+    long: Annotated[bool, Option("-v", "--long", help="More detailed output")] = False,
 ):
 
+    if install_jd:
+        print(
+            """
+jd() { 
+    target="$(res --dir "$@")"
+    cd "$target" 
+}
+        """
+        )
+        sys.exit(0)
+
     if user is None:
         user = get_user()
 
@@ -55,8 +72,19 @@ def show_log(
     job = job_getter()
 
     if job is None:
+        print("Could not get job")
         return None
 
+    if cwd:
+        cwd = job.get("current_working_directory")
+
+        if not cwd:
+            print("Could not get job's 'current_working_directory'")
+            sys.exit(1)
+
+        print(cwd)
+        sys.exit(0)
+
     layout_func = curry(dual_layout, log_layout_pair)
 
     layout = layout_func(job_getter=job_getter, long=long)
@@ -76,10 +104,6 @@ def show_log(
                 time.sleep(1)
         except KeyboardInterrupt:
             live.stop()
-            if wisdom:
-                from .wisdom import print_random_quote
-
-                print_random_quote()
 
 
 def log_layout_pair(job_getter, **kwargs):
@@ -102,64 +126,6 @@ def log_layout_pair(job_getter, **kwargs):
     return upper, lower
 
 
-def guess_current_job(user: str, **kwargs):
-
-    global JOB_DF
-    JOB_DF = combined_df(user=user, **kwargs)
-
-    assert len(JOB_DF), "No jobs found"
-
-    pending = JOB_DF[JOB_DF["job_state"] == "PENDING"]
-    running = JOB_DF[JOB_DF["job_state"] == "RUNNING"]
-    history = JOB_DF[~JOB_DF["job_state"].isin(["PENDING", "RUNNING"])]
-
-    # pick the single active job
-    if len(running) == 1:
-        return running.iloc[0]
-
-    # pick the most recently submitted active job
-    elif len(running) > 1:
-        return running.sort_values(by="submit_time", ascending=False).iloc[0]
-
-    # pick the single pending job
-    elif len(pending) == 1:
-        return pending.iloc[0]
-
-    # pick the most recently submitted pending job
-    elif len(pending) > 1:
-        return pending.sort_values(by="submit_time", ascending=False).iloc[0]
-
-    # pick the most recently submitted pending job
-    else:
-        return pending.sort_values(by="submit_time", ascending=False).iloc[0]
-
-    return job
-
-
-def get_specific_job(job: int, user: str, **kwargs):
-
-    global JOB_DF
-    JOB_DF = combined_df(user=user, **kwargs)
-
-    assert len(JOB_DF), "No jobs found"
-
-    matches = JOB_DF[JOB_DF["job_id"] == job]
-
-    if not len(matches):
-        console.print("[red bold]Could not find job with ID {job_id=}")
-        return None
-
-    elif len(matches) > 1:
-
-        matches = matches[matches["command"].notna()]
-
-        if len(matches) > 1:
-            console.print(matches.to_dict(orient="records"))
-            raise ValueError("Multiple job matches")
-
-    return matches.iloc[0]
-
-
 def main():
     app()
 

{richqueue-1.10 → richqueue-1.11}/richqueue/main.py

@@ -123,21 +123,6 @@ def show(
         console.print(f"[red bold]{e}[reset]")
 
 
-@app.command()
-def log(job: Annotated[int, Option(help="Show logs from a specific job")]):
-    raise NotImplementedError
-
-
-@app.command()
-def dir(job: Annotated[int, Option(help="Get job directory")]):
-    raise NotImplementedError
-
-
-@app.command()
-def nickname():
-    raise NotImplementedError
-
-
 def parse_history_string(hist: str, unit: str = "week") -> (int, str):
     """Parse one or two part string into integer value and string unit"""
 

richqueue-1.11/richqueue/submit.py

@@ -0,0 +1,54 @@
+import sys
+import subprocess
+from os import environ
+from pathlib import Path
+
+from .main import show
+from .console import console
+
+
+def submit():
+
+    log_dir = environ.get("LOGS")
+
+    if not log_dir:
+        console.print("[red bold]LOGS variable not set")
+        sys.exit(1)
+
+    log_dir = Path(log_dir)
+
+    sbatch_args = sys.argv[1:]
+
+    commands = [
+        "sbatch",
+        "--output=" f"{log_dir.resolve()}/%j.log",
+        "--error=" f"{log_dir.resolve()}/%j.log",
+        *sbatch_args,
+    ]
+
+    print(" ".join(commands))
+
+    x = subprocess.run(
+        commands, shell=False, stdout=subprocess.PIPE, stderr=subprocess.PIPE
+    )
+
+    if x.returncode != 0:
+        console.print(f"[red bold]{x.stderr.decode().strip()}")
+        sys.exit(1)
+
+    message = x.stdout.decode().strip()
+
+    job_id = int(message.split()[-1])
+
+    console.print(f"[bold green]{message}:")
+
+    show(job=job_id, no_loop=True, hist=None)
+    sys.exit(0)
+
+
+def main():
+    submit()
+
+
+if __name__ == "__main__":
+    main()

richqueue-1.10/PKG-INFO

@@ -1,61 +0,0 @@
-Metadata-Version: 2.4
-Name: richqueue
-Version: 1.10
-Summary: RichQueue
-Project-URL: Homepage, https://github.com/mwinokan/RichQueue/issues
-Project-URL: Bug Tracker, https://github.com/mwinokan/RichQueue/issues
-Author-email: Max Winokan <max@winokan.com>
-License-File: LICENSE
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
-Requires-Dist: pandas
-Requires-Dist: rich
-Requires-Dist: typer
-Description-Content-Type: text/markdown
-
-# 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```
-
-To see the last `X` weeks history:
-
-```rq --hist X```
-
-To see history for a given time period, e.g.:
-
-```rq --hist '3 days'```
-
-To list available nodes on the cluster:
-
-```rq --idle```
-
-To show a static view:
-
-```rq --no-loop```

richqueue-1.10/README.md

@@ -1,44 +0,0 @@
-# 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```
-
-To see the last `X` weeks history:
-
-```rq --hist X```
-
-To see history for a given time period, e.g.:
-
-```rq --hist '3 days'```
-
-To list available nodes on the cluster:
-
-```rq --idle```
-
-To show a static view:
-
-```rq --no-loop```