speedtest-ssh 2.10.2__tar.gz → 2.12.0__tar.gz

{speedtest_ssh-2.10.2/speedtest_ssh.egg-info → speedtest_ssh-2.12.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: speedtest_ssh
-Version: 2.10.2
+Version: 2.12.0
 Summary: A tool meant to check inter-device speeds via ssh
-License: GPL
+License-Expression: GPL-3.0-only
 Project-URL: Homepage, https://github.com/zwimer/speedtest_ssh
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: argcomplete

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/pyproject.toml

@@ -1,22 +1,23 @@
 [build-system]
-requires = ["setuptools>=61.2"]
+requires = ["setuptools>=77"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "speedtest_ssh"
 classifiers = [
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.12",
+	"Programming Language :: Python :: 3",
+	"Programming Language :: Python :: 3.14",
 ]
-license = {text = "GPL"}
+license = "GPL-3.0-only"
+license-files = ["LICENSE"]
 description = "A tool meant to check inter-device speeds via ssh"
 urls = {Homepage = "https://github.com/zwimer/speedtest_ssh"}
-requires-python = ">= 3.12"
+requires-python = ">= 3.14"
 dynamic = ["version"]
 dependencies = [
 	"argcomplete",
-    "paramiko",
-    "tqdm",
+	"paramiko",
+	"tqdm",
 ]
 
 [project.readme]
@@ -27,7 +28,6 @@ content-type = "text/markdown"
 speedtest-ssh = "speedtest_ssh:cli"
 
 [tool.setuptools]
-license-files = ["LICENSE"]
 include-package-data = false
 
 [tool.setuptools.packages]
@@ -49,10 +49,12 @@ disable = [
 	"line-too-long",
 	"invalid-name",
 ]
+[tool.pylint.main]
+jobs = 0
 
 [tool.black]
 line-length = 120
-target-version = ["py312"]
+target-version = ["py314", "py315"]
 
 [tool.ruff]
 line-length = 120

speedtest_ssh-2.12.0/speedtest_ssh/_version.py

@@ -0,0 +1 @@
+__version__: str = "2.12.0"

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/speedtest_ssh/config.py

@@ -3,9 +3,7 @@ from dataclasses import dataclass
 
 @dataclass(kw_only=True)
 class Config:
-    """
-    A simple config dataclass that holds information used to access a remote client
-    """
+    """A simple config dataclass that holds information used to access a remote client"""
 
     host: str
     user: str | None

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/speedtest_ssh/data_transfer.py

@@ -1,4 +1,3 @@
-from __future__ import annotations
 from subprocess import CalledProcessError, PIPE
 from logging import getLogger, DEBUG, INFO
 from typing import TYPE_CHECKING, Self
@@ -30,17 +29,16 @@ def _rand_str(size: int) -> str:
 
 
 class ProgressBar(tqdm):
-    """
-    A small tqdm wrapper for paramiko's SFTP callbacks to use
-    """
+    """A small tqdm wrapper for paramiko's SFTP callbacks to use"""
 
     def __init__(self, desc: str):
         super().__init__(desc=desc, unit="B", unit_scale=True, unit_divisor=1024, dynamic_ncols=True)
 
     def __call__(self, bytes_done: int, bytes_remaining: int):
         """
-        :param bytes_done: The number of bytes transferred
-        :param bytes_remaining: The number of bytes yet to be transferred
+        Args:
+            bytes_done: The number of bytes transferred
+            bytes_remaining: The number of bytes yet to be transferred
         """
         self.total: int | None
         if self.total is None:
@@ -49,8 +47,7 @@ class ProgressBar(tqdm):
 
 
 class DataTransfer:
-    """
-    A context manager used to send and receive data to and from the remote client
+    """A context manager used to send and receive data to and from the remote client
     This class is a context manager; on exit will remove the remote file on deletion
     """
 
@@ -58,7 +55,8 @@ class DataTransfer:
 
     def __init__(self, config: Config):
         """
-        :param config: The Config object the DataTransfer instance should use
+        Args:
+            config: The Config object the DataTransfer instance should use
         """
         self._l = getLogger(self._LOG)
         self._remote_f: str = f"/tmp/speedtest-ssh_{datetime.now(tz=UTC)}_{_rand_str(8)}.tmp"
@@ -79,21 +77,15 @@ class DataTransfer:
         self._sftp_cm.__exit__(*args, **kwargs)
 
     def put(self, local: Path) -> None:
-        """
-        Send the local file to be saved at the remote path
-        """
+        """Send the local file to be saved at the remote path"""
         raise NotImplementedError
 
     def get(self, local: Path) -> None:
-        """
-        Get the remote file to and save it at the local path
-        """
+        """Get the remote file to and save it at the local path"""
         raise NotImplementedError
 
     def clean_remote(self) -> None:
-        """
-        Removes the remote file
-        """
+        """Removes the remote file"""
         try:
             self._l.debug("Removing remote file (if it exists): %s", self._remote_f)
             self._sftp.remove(self._remote_f)
@@ -102,9 +94,7 @@ class DataTransfer:
 
 
 class SFTP(DataTransfer):
-    """
-    A DataTransfer classes that uses SFTP
-    """
+    """A DataTransfer classes that uses SFTP"""
 
     def put(self, local: Path) -> None:
         with ProgressBar("Upload   ") as p:
@@ -116,14 +106,14 @@ class SFTP(DataTransfer):
 
 
 class Rsync(DataTransfer):
-    """
-    A DataTransfer that uses rsync
+    """A DataTransfer that uses rsync
     Requires rsync be installed
     """
 
     def __init__(self, config: Config):
         """
-        :param host: The hostname ssh uses for the remote client
+        Args:
+            host: The hostname ssh uses for the remote client
         """
         super().__init__(config)
         self._remote_f = re.sub(r"[^a-zA-Z\d_/-]", "_", self._remote_f)  # Old rsync args suck
@@ -159,8 +149,9 @@ class Rsync(DataTransfer):
 
     def _transfer(self, src: str | Path, dst: str | Path) -> None:
         """
-        :param src: The file to rsync to dst
-        :param dst: The location to rsync src to
+        Args:
+            src: The file to rsync to dst
+            dst: The location to rsync src to
         """
         try:
             _ = run_cmd(self._rsync, *self._flags, src, dst, env=self._env, check=True)

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/speedtest_ssh/ping.py

@@ -11,15 +11,16 @@ _LOG = "Ping"
 
 
 class PingFailed(RuntimeError):
-    """
-    Raise on ping failure
-    """
+    """Raise on ping failure"""
 
 
 def ping(host: str, n_pings: int = 10, max_wait: int = 3) -> float:
     """
-    :param host: The host to ping
-    :return: The number Ping host
+    Args:
+        host: The host to ping
+
+    Returns:
+        The number Ping host
     """
     # We use subprocess b/c ping is suid and we don't want to require root
     print("Pinging...")

speedtest_ssh-2.12.0/speedtest_ssh/py.typed

@@ -0,0 +1 @@
+

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/speedtest_ssh/sftp_wrapper.py

@@ -21,9 +21,10 @@ _LOG = "SFTPWrapper"
 
 
 def create_paramiko_config(raw: Config) -> dict:
-    """
-    Create a dict for paramiko to use as its config
-    :return: A dict containing info needed for paramiko to ssh
+    """Create a dict for paramiko to use as its config
+
+    Returns:
+        A dict containing info needed for paramiko to ssh
     """
     log = getLogger(_LOG)
     config: dict[str, str | int | None] = dataclasses.asdict(raw)
@@ -56,9 +57,7 @@ def create_paramiko_config(raw: Config) -> dict:
 
 
 def load_keys(client: SSHClient, host: str, port: int) -> None:
-    """
-    Load available ssh keys into the ssh client
-    """
+    """Load available ssh keys into the ssh client"""
     log = getLogger(_LOG)
     hosts_f = Path.home() / ".ssh/known_hosts"
     if hosts_f.exists():
@@ -73,10 +72,8 @@ def load_keys(client: SSHClient, host: str, port: int) -> None:
 
 
 @contextmanager
-def sftp_wrapper(raw: Config) -> Generator["SFTPClient", None, None]:
-    """
-    A context manager which yields a conncted SFTPClient
-    """
+def sftp_wrapper(raw: Config) -> Generator[SFTPClient]:
+    """A context manager which yields a conncted SFTPClient"""
     log = getLogger(_LOG)
     log.debug("Initializing ssh client")
     with SSHClient() as client:

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/speedtest_ssh/speedtest_ssh.py

@@ -21,12 +21,15 @@ _LOG = "speedtest_ssh"
 
 
 def _iteration(temp: Path, client: DataTransfer, size: int) -> tuple[int, int]:
-    """
-    Time uploading and downloading a file of size bytes
-    :param temp: A temporary file we have ownership of
-    :param client: A client used to transfer the data
-    :param size: how much data to transfer
-    :return: <nanoseconds to upload>, <nanoseconds to download>
+    """Time uploading and downloading a file of size bytes
+
+    Args:
+        temp: A temporary file we have ownership of
+        client: A client used to transfer the data
+        size: how much data to transfer
+
+    Returns:
+        <nanoseconds to upload>, <nanoseconds to download>
     """
     # Create the file to upload; sendfile not always supported so we do this the hard way
     log = getLogger(_LOG)
@@ -56,18 +59,14 @@ def _iteration(temp: Path, client: DataTransfer, size: int) -> tuple[int, int]:
 
 
 def _print_results(ping_delay: float | None, up_ns: int, down_ns: int, size: int) -> None:
-    """
-    Print the speed test results
-    """
+    """Print the speed test results"""
     prefix = "\n" + ("" if ping_delay is None else f"Ping: {ping_delay} ms\n")
     fmt = lambda s: f"{8 * (size/1024**2) / (s/1000**3):.2f} Mbit/s"
     print(f"{prefix}Upload Speed: {fmt(up_ns)}\nDownload Speed: {fmt(down_ns)}")
 
 
 def speedtest_ssh(seconds: int, ping: bool, mode: str, conf: Config) -> None:
-    """
-    Run speedtest_ssh
-    """
+    """Run speedtest_ssh"""
     log = getLogger(_LOG)
     ping_delay: float | None = ping_test(conf.host) if ping else None
     print("Connecting...")
@@ -93,9 +92,7 @@ def speedtest_ssh(seconds: int, ping: bool, mode: str, conf: Config) -> None:
 
 
 def cli() -> None:
-    """
-    speedtest_ssh main
-    """
+    """speedtest_ssh main"""
     parser = argparse.ArgumentParser()
     parser.add_argument("-V", "--version", action="version", version=f"{parser.prog} {__version__}")
     remote = parser.add_argument_group("SSH Options")
@@ -128,7 +125,7 @@ def cli() -> None:
     # Configure logging
     lvl = ns.pop("verbose")
     lvl = _LOG_VERBOSITY[max(i for i in _LOG_VERBOSITY if i <= lvl)]
-    basicConfig(level=lvl, format="%(levelname)-8s %(message)s")
+    basicConfig(level=lvl, format="%(levelname)-7s - %(message)s")
     getLogger("main").debug("Log level set to %d", lvl)
     # Call speedtest
     ns["password"] = None

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0}/speedtest_ssh/util.py

@@ -13,8 +13,11 @@ _LOG = "Util"
 
 def find_exe(name: str) -> Path:
     """
-    :param name: The name of the executable to find
-    :return: The path to the executable
+    Args:
+        name: The name of the executable to find
+
+    Returns:
+        The path to the executable
     """
     where: str | None = which(name)
     if where is None:
@@ -36,10 +39,13 @@ def _log_cmd(cmd: Path, args: tuple[str | Path, ...]) -> None:
 
 def run_cmd(cmd: Path, *args: str | Path, **kwargs) -> subprocess.CompletedProcess:
     """
-    :param cmd: The command to run
-    :param args: The arguments of cmd
-    :param kwargs: Fowarded to subprocess.Popen
-    :return: Completed process
+    Args:
+        cmd: The command to run
+        *args: The arguments of cmd
+        **kwargs: Fowarded to subprocess.Popen
+
+    Returns:
+        Completed process
     """
     _log_cmd(cmd, args)
     return subprocess.run((cmd, *args), **kwargs)  # nosec B603  # noqa: PLW1510
@@ -47,11 +53,14 @@ def run_cmd(cmd: Path, *args: str | Path, **kwargs) -> subprocess.CompletedProce
 
 def tee_cmd(cmd: Path, *args: str | Path, level: int, **kwargs) -> tuple[subprocess.Popen, str]:
     """
-    :param cmd: The command to run (and info log the output of)
-    :param args: The arguments of cmd
-    :param level: The log level to use
-    :param kwargs: Fowarded to subprocess.Popen aside from test and stdout
-    :return: Completed process, stdout (do not read stdout from CompletedProcess)
+    Args:
+        cmd: The command to run (and info log the output of)
+        *args: The arguments of cmd
+        level: The log level to use
+        **kwargs: Fowarded to subprocess.Popen aside from test and stdout
+
+    Returns:
+        Completed process, stdout (do not read stdout from CompletedProcess)
     """
     assert "text" not in kwargs  # nosec B101
     assert "stdout" not in kwargs  # nosec B101

{speedtest_ssh-2.10.2 → speedtest_ssh-2.12.0/speedtest_ssh.egg-info}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: speedtest_ssh
-Version: 2.10.2
+Version: 2.12.0
 Summary: A tool meant to check inter-device speeds via ssh
-License: GPL
+License-Expression: GPL-3.0-only
 Project-URL: Homepage, https://github.com/zwimer/speedtest_ssh
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.12
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.14
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: argcomplete

speedtest_ssh-2.10.2/speedtest_ssh/_version.py

@@ -1 +0,0 @@
-__version__: str = "2.10.2"

speedtest_ssh-2.10.2/speedtest_ssh/py.typed

@@ -1 +0,0 @@
-PARTIAL