sot 1.0.0__tar.gz

sot-1.0.0/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2024, Kumar Anirudha
+Copyright (c) 2021-2022 Nico Schlömer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sot-1.0.0/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.1
+Name: sot
+Version: 1.0.0
+Summary: System Oberving Tool
+Author-email: Kumar Anirudha <dev@anirudha.dev>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2024, Kumar Anirudha
+        Copyright (c) 2021-2022 Nico Schlömer
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Code, https://github.com/anistark/sot
+Project-URL: Issues, https://github.com/anistark/sot/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: py-cpuinfo
+Requires-Dist: distro
+Requires-Dist: psutil
+Requires-Dist: rich>=11.0.0
+Requires-Dist: textual<0.2,>=0.1.15
+
+<p align="center">
+  <a href="https://github.com/anistark/sot"><img alt="tiptop" src="./images/sot.png" width="200px"/></a>
+  <p align="center">Command-line system oberving tool.</p>
+</p>
+
+`sot` is a Command-line System Obervation Tool in the spirit of [top](<https://en.wikipedia.org/wiki/Top_(software)>). It displays various interesting system stats and graphs them. Works on all operating systems.
+
+Install and run with
+
+<!--pytest-codeblocks: skip-->
+
+```sh
+pip install sot
+sot
+```
+
+For all options, see
+
+<!--pytest-codeblocks:skipif(sys.version_info < (3, 10))-->
+
+```sh
+sot -H
+```
+
+<!--pytest-codeblocks: expected-output-->
+
+```
+usage: sot [--help] [--version] [--log LOG] [--net NET]
+
+Command-line System Obervation Tool ≈
+
+options:
+  --help, -H     Show this help message and exit.
+  --version, -V  Display version information
+  --log, -L LOG  Debug log file
+  --net, -N NET  Network interface to display (default: auto)
+```
+
+Main Theme:
+
+| Color | Hex | RGB |
+| --- | --- | --- |
+| sky_blue3 | `#5fafd7` | `rgb(95,175,215)` |
+| aquamarine3 | `#5fd7af` | `rgb(95,215,175)` |
+| yellow | `#808000` | `rgb(128,128,0)` |
+| bright_black | `#808080` | `rgb(128,128,128)` |
+| slate_blue1 | `#875fff` | `rgb(135,95,255)` |
+| red3 | `#d70000` | `rgb(215,0,0)` |
+| dark_orange | `#d75f00` | `rgb(215,95,0)` |
+
+All supported [colors](https://rich.readthedocs.io/en/latest/appendix/colors.html).
+
+---
+
+<p align="center">
+  <p align="center">🏴 ≈ 🏴</p>
+</p>
+
+---
+
+`sot` uses [Textual](https://github.com/willmcgugan/textual/) for layouting, [rich](https://rich.readthedocs.io/en/latest/index.html) for rich text and [psutil](https://github.com/giampaolo/psutil) for fetching system data.
+
+Other top alternatives in alphabetical order:
+
+- [tiptop](https://github.com/nschloe/tiptop) ✨ This project was created on top of `tiptop`, when it became unmaintained.
+- [bashtop](https://github.com/aristocratos/bashtop), [bpytop](https://github.com/aristocratos/bpytop), [btop](https://github.com/aristocratos/btop)
+- [bottom](https://github.com/ClementTsang/bottom) (one of my fav)
+- [Glances](https://github.com/nicolargo/glances)
+- [gtop](https://github.com/aksakalli/gtop)
+- [htop](https://github.com/htop-dev/htop)

sot-1.0.0/README.md

@@ -0,0 +1,70 @@
+<p align="center">
+  <a href="https://github.com/anistark/sot"><img alt="tiptop" src="./images/sot.png" width="200px"/></a>
+  <p align="center">Command-line system oberving tool.</p>
+</p>
+
+`sot` is a Command-line System Obervation Tool in the spirit of [top](<https://en.wikipedia.org/wiki/Top_(software)>). It displays various interesting system stats and graphs them. Works on all operating systems.
+
+Install and run with
+
+<!--pytest-codeblocks: skip-->
+
+```sh
+pip install sot
+sot
+```
+
+For all options, see
+
+<!--pytest-codeblocks:skipif(sys.version_info < (3, 10))-->
+
+```sh
+sot -H
+```
+
+<!--pytest-codeblocks: expected-output-->
+
+```
+usage: sot [--help] [--version] [--log LOG] [--net NET]
+
+Command-line System Obervation Tool ≈
+
+options:
+  --help, -H     Show this help message and exit.
+  --version, -V  Display version information
+  --log, -L LOG  Debug log file
+  --net, -N NET  Network interface to display (default: auto)
+```
+
+Main Theme:
+
+| Color | Hex | RGB |
+| --- | --- | --- |
+| sky_blue3 | `#5fafd7` | `rgb(95,175,215)` |
+| aquamarine3 | `#5fd7af` | `rgb(95,215,175)` |
+| yellow | `#808000` | `rgb(128,128,0)` |
+| bright_black | `#808080` | `rgb(128,128,128)` |
+| slate_blue1 | `#875fff` | `rgb(135,95,255)` |
+| red3 | `#d70000` | `rgb(215,0,0)` |
+| dark_orange | `#d75f00` | `rgb(215,95,0)` |
+
+All supported [colors](https://rich.readthedocs.io/en/latest/appendix/colors.html).
+
+---
+
+<p align="center">
+  <p align="center">🏴 ≈ 🏴</p>
+</p>
+
+---
+
+`sot` uses [Textual](https://github.com/willmcgugan/textual/) for layouting, [rich](https://rich.readthedocs.io/en/latest/index.html) for rich text and [psutil](https://github.com/giampaolo/psutil) for fetching system data.
+
+Other top alternatives in alphabetical order:
+
+- [tiptop](https://github.com/nschloe/tiptop) ✨ This project was created on top of `tiptop`, when it became unmaintained.
+- [bashtop](https://github.com/aristocratos/bashtop), [bpytop](https://github.com/aristocratos/bpytop), [btop](https://github.com/aristocratos/btop)
+- [bottom](https://github.com/ClementTsang/bottom) (one of my fav)
+- [Glances](https://github.com/nicolargo/glances)
+- [gtop](https://github.com/aksakalli/gtop)
+- [htop](https://github.com/htop-dev/htop)

sot-1.0.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61"]
+build-backend = "setuptools.build_meta"
+
+[tool.isort]
+profile = "black"
+
+[project]
+name = "sot"
+authors = [{name = "Kumar Anirudha", email = "dev@anirudha.dev"}]
+description = "System Oberving Tool"
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: POSIX :: Linux",
+  "Operating System :: MacOS",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.7",
+  "Programming Language :: Python :: 3.8",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Topic :: Utilities",
+]
+dynamic = ["version"]
+requires-python = ">=3.7"
+dependencies = [
+   "py-cpuinfo",
+   "distro",
+   "psutil",
+   "rich >= 11.0.0",
+   "textual >=0.1.15, <0.2",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "sot.__about__.__version__"}
+
+[project.urls]
+Code = "https://github.com/anistark/sot"
+Issues = "https://github.com/anistark/sot/issues"
+
+[project.scripts]
+sot = "sot._app:run"

sot-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

sot-1.0.0/src/sot/__about__.py

@@ -0,0 +1,4 @@
+from datetime import datetime
+
+__version__ = "1.0.0"
+__current_year__ = datetime.now().year

sot-1.0.0/src/sot/__init__.py

@@ -0,0 +1,6 @@
+from .__about__ import __version__, __current_year__
+from ._app import run
+from .blockchar_stream import BlockCharStream
+from .braille_stream import BrailleStream
+
+__all__ = ["BrailleStream", "BlockCharStream", "run", "__version__", "__current_year__"]

sot-1.0.0/src/sot/_app.py

@@ -0,0 +1,107 @@
+from __future__ import annotations
+
+import argparse
+from sys import version_info
+
+from textual.app import App
+
+from .__about__ import __version__, __current_year__
+from ._cpu import CPU
+from ._disk import Disk
+from ._info import InfoLine
+from ._mem import Mem
+from ._net import Net
+from ._procs_list import ProcsList
+# from ._sot import Sot
+
+def run(argv=None):
+    parser = argparse.ArgumentParser(
+        description="Command-line System Obervation Tool ≈",
+        formatter_class=argparse.RawTextHelpFormatter,
+        add_help=False
+    )
+
+    parser.add_argument(
+        "--help",
+        "-H",
+        action="help",
+        default=argparse.SUPPRESS,
+        help="Show this help message and exit."
+    )
+
+    parser.add_argument(
+        "--version",
+        "-V",
+        action="version",
+        version=_get_version_text(),
+        help="Display version information",
+    )
+
+    parser.add_argument(
+        "--log",
+        "-L",
+        type=str,
+        default=None,
+        help="Debug log file",
+    )
+
+    parser.add_argument(
+        "--net",
+        "-N",
+        type=str,
+        default=None,
+        help="Network interface to display (default: auto)",
+    )
+
+    args = parser.parse_args(argv)
+
+    # with a grid
+    class sotApp(App):
+        async def on_mount(self) -> None:
+            grid = await self.view.dock_grid(edge="left")
+
+            grid.add_column(fraction=36, name="left")
+            # grid.add_column(fraction=15, name="middle")
+            # grid.add_column(fraction=36, name="right")
+            grid.add_column(fraction=45, name="right")
+
+            grid.add_row(size=1, name="r0")
+            grid.add_row(fraction=1, name="r1")
+            grid.add_row(fraction=1, name="r2")
+            grid.add_row(fraction=1, name="r3")
+            grid.add_areas(
+                area0="left-start|right-end,r0",
+                area1="left,r1",
+                # area2a="middle,r1-start|r1-end",
+                # area2b="middle,r2-start|r2-end",
+                # area2c="middle,r3-start|r3-end",
+                area3a="right,r1",
+                area3b="right,r2",
+                area3c="right,r3",
+                area4="left,r2-start|r3-end",
+            )
+            grid.place(
+                area0=InfoLine(),
+                area1=CPU(),
+                # area2b=Sot(),
+                area3a=Mem(),
+                area3b=Disk(),
+                area3c=Net(args.net),
+                area4=ProcsList(),
+            )
+
+        async def on_load(self, _):
+            await self.bind("q", "quit", "quit")
+
+    sotApp.run(log=args.log)
+
+
+def _get_version_text():
+    python_version = f"{version_info.major}.{version_info.minor}.{version_info.micro}"
+
+    return "\n".join(
+        [
+            f"sot {__version__} [Python {python_version}]",
+            f"Copyright (c) 2024-{__current_year__} Kumar Anirudha",
+        ]
+    )

sot-1.0.0/src/sot/_battery.py

@@ -0,0 +1,62 @@
+import psutil
+from rich import box
+from rich.panel import Panel
+from rich.text import Text
+from textual.widget import Widget
+
+from .braille_stream import BrailleStream
+
+
+class Battery(Widget):
+    def on_mount(self):
+        self.bat_stream = BrailleStream(40, 3, 0.0, 100.0)
+
+        self.panel = Panel(
+            "",
+            title="",
+            title_align="left",
+            # border_style="yellow",
+            border_style="bright_black",
+            box=box.SQUARE,
+        )
+        self.collect_data()
+        # update frequency: 1 min
+        self.set_interval(60.0, self.collect_data)
+
+    def collect_data(self):
+        bat = psutil.sensors_battery()
+        assert bat is not None
+
+        self.bat_stream.add_value(bat.percent)
+        self.refresh_graph()
+
+        if bat.power_plugged:
+            status = "charging"
+        else:
+            mm = bat.secsleft // 60
+            hh, mm = divmod(mm, 60)
+            time_left_str = []
+            if hh > 0:
+                time_left_str.append(f"{hh}h")
+            if mm > 0:
+                time_left_str.append(f"{mm}min")
+            status = " ".join(time_left_str) + " left"
+
+        title = f"[b]battery[/] - {self.bat_stream.values[-1]:.1f}% - {status}"
+        if bat.percent < 15 and not bat.power_plugged:
+            title = "[red3 reverse bold]" + title + "[/]"
+
+        self.panel.title = title
+
+        self.refresh()
+
+    def refresh_graph(self):
+        self.panel.renderable = Text("\n".join(self.bat_stream.graph), style="yellow")
+
+    def render(self) -> Panel:
+        return self.panel
+
+    async def on_resize(self, event):
+        self.bat_stream.reset_width(event.width - 4)
+        self.bat_stream.reset_height(event.height - 2)
+        self.refresh_graph()