squid-tui 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- squid_tui-0.0.1/PKG-INFO +11 -0
- squid_tui-0.0.1/README.md +58 -0
- squid_tui-0.0.1/pyproject.toml +49 -0
- squid_tui-0.0.1/python/squid_tui.egg-info/PKG-INFO +11 -0
- squid_tui-0.0.1/python/squid_tui.egg-info/SOURCES.txt +20 -0
- squid_tui-0.0.1/python/squid_tui.egg-info/dependency_links.txt +1 -0
- squid_tui-0.0.1/python/squid_tui.egg-info/entry_points.txt +2 -0
- squid_tui-0.0.1/python/squid_tui.egg-info/requires.txt +5 -0
- squid_tui-0.0.1/python/squid_tui.egg-info/top_level.txt +1 -0
- squid_tui-0.0.1/python/squidlib/__init__.py +9 -0
- squid_tui-0.0.1/python/squidlib/app.py +918 -0
- squid_tui-0.0.1/python/squidlib/cli/__init__.py +0 -0
- squid_tui-0.0.1/python/squidlib/cli/cli_main.py +53 -0
- squid_tui-0.0.1/python/squidlib/constants.py +141 -0
- squid_tui-0.0.1/python/squidlib/screens.py +429 -0
- squid_tui-0.0.1/python/squidlib/slurm.py +317 -0
- squid_tui-0.0.1/python/squidlib/widgets.py +105 -0
- squid_tui-0.0.1/setup.cfg +4 -0
- squid_tui-0.0.1/tests/test_app_logic.py +206 -0
- squid_tui-0.0.1/tests/test_cli.py +46 -0
- squid_tui-0.0.1/tests/test_constants.py +87 -0
- squid_tui-0.0.1/tests/test_slurm.py +297 -0
squid_tui-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: squid-tui
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Keywords: slurm,tui,hpc,cluster
|
|
5
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
6
|
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
7
|
+
Requires-Python: >=3.10
|
|
8
|
+
Requires-Dist: textual>=0.40.0
|
|
9
|
+
Provides-Extra: dev
|
|
10
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
11
|
+
Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# Squid-TUI
|
|
2
|
+
|
|
3
|
+
[](https://github.com/pirl-unc/squid/actions/workflows/ci.yml)
|
|
4
|
+
|
|
5
|
+
**squid-tui** (**S**lurm **QU**eue **I**nteractive **D**ashboard) is a terminal UI (TUI) for monitoring and managing
|
|
6
|
+
your SLURM jobs, built with [Textual](https://github.com/Textualize/textual).
|
|
7
|
+
|
|
8
|
+
## 01. Features
|
|
9
|
+
|
|
10
|
+
- **Tabbed job views** — Pending, Active, and History tabs with color-coded job states
|
|
11
|
+
- **Job history** — Completed, failed, cancelled, and timed-out jobs from the last 24 hours
|
|
12
|
+
- **Custom lists** — Organize jobs into lists (e.g. "ML Training", "Bioinformatics")
|
|
13
|
+
- **Job actions** — Cancel jobs, view detailed `scontrol`/`sacct` output, tail stdout/stderr
|
|
14
|
+
- **Multi-select** — Toggle select mode (`v`), select jobs with `space` or arrows, then act on all at once
|
|
15
|
+
- **Search** — Filter jobs by name or ID with `/`
|
|
16
|
+
- **Notes** — Annotate any job with a short note, persisted across sessions
|
|
17
|
+
- **Copy job ID** — Copy job IDs to the system clipboard (`y`)
|
|
18
|
+
- **Cluster overview** — Partition summary and per-node detail (`sinfo -N`) in a dedicated sidebar section
|
|
19
|
+
- **Auto-refresh** — Configurable refresh interval (default: 180s)
|
|
20
|
+
- **Persistent config** — Lists, assignments, and notes saved to `~/.squid_tui.json`
|
|
21
|
+
|
|
22
|
+
## 02. Installation
|
|
23
|
+
|
|
24
|
+
Requires Python 3.10+.
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pip install .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## 03. Usage
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
squid-tui # Show your jobs (uses $USER)
|
|
34
|
+
squid-tui --all # Show jobs for all users
|
|
35
|
+
squid-tui --user alice # Show jobs for a specific user
|
|
36
|
+
squid-tui --refresh 60 # Set auto-refresh to 60 seconds
|
|
37
|
+
squid-tui --version # Print version
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## 04. Demo
|
|
41
|
+
|
|
42
|
+
You can run squid-tui with simulated SLURM data (no cluster required):
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
python examples/demo.py
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## 05. Running Tests
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
pip install -e ".[dev]"
|
|
52
|
+
python -m pytest tests/ -v
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## 06. License
|
|
56
|
+
|
|
57
|
+
Apache License 2.0
|
|
58
|
+
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
2
|
+
# you may not use this file except in compliance with the License.
|
|
3
|
+
# You may obtain a copy of the License at
|
|
4
|
+
#
|
|
5
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
6
|
+
#
|
|
7
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
8
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
+
# See the License for the specific language governing permissions and
|
|
11
|
+
# limitations under the License.
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
[build-system]
|
|
15
|
+
requires = ["setuptools>=65", "wheel"]
|
|
16
|
+
build-backend = "setuptools.build_meta"
|
|
17
|
+
|
|
18
|
+
[project]
|
|
19
|
+
name = "squid-tui"
|
|
20
|
+
version = "0.0.1"
|
|
21
|
+
requires-python = ">=3.10"
|
|
22
|
+
keywords = [
|
|
23
|
+
"slurm",
|
|
24
|
+
"tui",
|
|
25
|
+
"hpc",
|
|
26
|
+
"cluster"
|
|
27
|
+
]
|
|
28
|
+
classifiers = [
|
|
29
|
+
"Programming Language :: Python :: Implementation :: CPython",
|
|
30
|
+
"Programming Language :: Python :: Implementation :: PyPy",
|
|
31
|
+
]
|
|
32
|
+
dependencies = [
|
|
33
|
+
"textual>=0.40.0",
|
|
34
|
+
]
|
|
35
|
+
|
|
36
|
+
[project.optional-dependencies]
|
|
37
|
+
dev = [
|
|
38
|
+
"pytest>=7.0",
|
|
39
|
+
"pytest-mock>=3.10.0",
|
|
40
|
+
]
|
|
41
|
+
|
|
42
|
+
[tool.setuptools.packages.find]
|
|
43
|
+
where = ["python"]
|
|
44
|
+
|
|
45
|
+
[tool.pytest.ini_options]
|
|
46
|
+
testpaths = ["tests"]
|
|
47
|
+
|
|
48
|
+
[project.scripts]
|
|
49
|
+
squid-tui = "squidlib.cli.cli_main:run"
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: squid-tui
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Keywords: slurm,tui,hpc,cluster
|
|
5
|
+
Classifier: Programming Language :: Python :: Implementation :: CPython
|
|
6
|
+
Classifier: Programming Language :: Python :: Implementation :: PyPy
|
|
7
|
+
Requires-Python: >=3.10
|
|
8
|
+
Requires-Dist: textual>=0.40.0
|
|
9
|
+
Provides-Extra: dev
|
|
10
|
+
Requires-Dist: pytest>=7.0; extra == "dev"
|
|
11
|
+
Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
README.md
|
|
2
|
+
pyproject.toml
|
|
3
|
+
python/squid_tui.egg-info/PKG-INFO
|
|
4
|
+
python/squid_tui.egg-info/SOURCES.txt
|
|
5
|
+
python/squid_tui.egg-info/dependency_links.txt
|
|
6
|
+
python/squid_tui.egg-info/entry_points.txt
|
|
7
|
+
python/squid_tui.egg-info/requires.txt
|
|
8
|
+
python/squid_tui.egg-info/top_level.txt
|
|
9
|
+
python/squidlib/__init__.py
|
|
10
|
+
python/squidlib/app.py
|
|
11
|
+
python/squidlib/constants.py
|
|
12
|
+
python/squidlib/screens.py
|
|
13
|
+
python/squidlib/slurm.py
|
|
14
|
+
python/squidlib/widgets.py
|
|
15
|
+
python/squidlib/cli/__init__.py
|
|
16
|
+
python/squidlib/cli/cli_main.py
|
|
17
|
+
tests/test_app_logic.py
|
|
18
|
+
tests/test_cli.py
|
|
19
|
+
tests/test_constants.py
|
|
20
|
+
tests/test_slurm.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
squidlib
|