zspeedtest 0.1.1__tar.gz

zspeedtest-0.1.1/PKG-INFO

@@ -0,0 +1,84 @@
+Metadata-Version: 2.4
+Name: zspeedtest
+Version: 0.1.1
+Summary: zspeedtest
+Keywords: zspeedtest
+Author: Sergey
+Author-email: Sergey <kava.develop@protonmail.com>
+License-Expression: MIT
+Classifier: Typing :: Typed
+Classifier: Framework :: Pytest
+Classifier: Framework :: AsyncIO
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10, <3.15
+Project-URL: Homepage, https://theseriff.github.io/zspeedtest/
+Project-URL: Repository, https://github.com/theseriff/zspeedtest
+Project-URL: Documentation, https://theseriff.github.io/zspeedtest/
+Project-URL: Changelog, https://github.com/theseriff/zspeedtest/blob/main/docs/CHANGELOG.md
+Project-URL: Issues, https://github.com/theseriff/zspeedtest/issues
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+<h1>zspeedtest</h1>
+<p><strong>Simple CLI internet speed tester. Downloads a file and measures throughput.</strong></p>
+
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/zspeedtest.svg)](https://pypi.org/project/zspeedtest)
+[![PyPI version](https://badge.fury.io/py/zspeedtest.svg)](https://pypi.python.org/pypi/zspeedtest)
+[![Tests](https://github.com/theseriff/zspeedtest/actions/workflows/pr_tests.yaml/badge.svg)](https://github.com/theseriff/zspeedtest/actions/workflows/pr_tests.yaml)
+[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/theseriff/zspeedtest.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/theseriff/zspeedtest)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+</div>
+
+```bash
+uv add zspeedtest
+zspeedtest
+```
+
+## Usage
+
+```
+zspeedtest [URL] [--requests N] [--timeout N]
+```
+
+- `URL` — large file to download (default: 10MB test file from ThinkBroadband)
+- `--requests`/`-n` — number of test requests (default: 10)
+- `--timeout`/`-t` — per-request timeout in seconds (default: 30)
+
+### Examples
+
+```bash
+zspeedtest
+zspeedtest http://example.com/file.bin --requests 5
+zspeedtest http://example.com/file.bin -n 3 -t 15
+```
+
+Output:
+
+```bash
+URL: http://ipv4.download.thinkbroadband.com/10MB.zip
+Requests: 1
+----------------------------------------------------
+  #        Size      Time         Speed
+----------------------------------------------------
+
+  1     10.0 MB    29.95s        0.33 MB/s
+====================================================
+Successful requests : 1 / 1
+Total downloaded    : 10.0 MB
+Average time        : 29.95 s
+Average speed       : 0.33 MB/s
+Min / Max           : 0.33 / 0.33 MB/s
+```

zspeedtest-0.1.1/README.md

@@ -0,0 +1,53 @@
+<div align="center">
+
+<h1>zspeedtest</h1>
+<p><strong>Simple CLI internet speed tester. Downloads a file and measures throughput.</strong></p>
+
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/zspeedtest.svg)](https://pypi.org/project/zspeedtest)
+[![PyPI version](https://badge.fury.io/py/zspeedtest.svg)](https://pypi.python.org/pypi/zspeedtest)
+[![Tests](https://github.com/theseriff/zspeedtest/actions/workflows/pr_tests.yaml/badge.svg)](https://github.com/theseriff/zspeedtest/actions/workflows/pr_tests.yaml)
+[![Coverage](https://coverage-badge.samuelcolvin.workers.dev/theseriff/zspeedtest.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/theseriff/zspeedtest)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+</div>
+
+```bash
+uv add zspeedtest
+zspeedtest
+```
+
+## Usage
+
+```
+zspeedtest [URL] [--requests N] [--timeout N]
+```
+
+- `URL` — large file to download (default: 10MB test file from ThinkBroadband)
+- `--requests`/`-n` — number of test requests (default: 10)
+- `--timeout`/`-t` — per-request timeout in seconds (default: 30)
+
+### Examples
+
+```bash
+zspeedtest
+zspeedtest http://example.com/file.bin --requests 5
+zspeedtest http://example.com/file.bin -n 3 -t 15
+```
+
+Output:
+
+```bash
+URL: http://ipv4.download.thinkbroadband.com/10MB.zip
+Requests: 1
+----------------------------------------------------
+  #        Size      Time         Speed
+----------------------------------------------------
+
+  1     10.0 MB    29.95s        0.33 MB/s
+====================================================
+Successful requests : 1 / 1
+Total downloaded    : 10.0 MB
+Average time        : 29.95 s
+Average speed       : 0.33 MB/s
+Min / Max           : 0.33 / 0.33 MB/s
+```

zspeedtest-0.1.1/pyproject.toml

@@ -0,0 +1,241 @@
+[build-system]
+requires = ["uv_build>=0.11.23,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = "src"
+
+[project]
+name = "zspeedtest"
+version = "0.1.1"
+description = "zspeedtest"
+requires-python = ">=3.10,<3.15"
+readme = "README.md"
+license = "MIT"
+authors = [{ name = "Sergey", email = "kava.develop@protonmail.com" }]
+keywords = ["zspeedtest"]
+classifiers = [
+    "Typing :: Typed",
+    "Framework :: Pytest",
+    "Framework :: AsyncIO",
+    "Natural Language :: English",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Utilities",
+]
+dependencies = []
+
+[project.scripts]
+zspeedtest = "zspeedtest.main:run"
+
+[dependency-groups]
+lint = [
+    "mypy==2.1.0",
+    "ruff==0.15.18",
+    "bandit==1.9.4",
+    "zizmor==1.25.2",
+    "semgrep==1.167.0",
+    "codespell==2.4.2",
+    "ty==0.0.54",
+    # mypy extensions
+    "mypy-extensions==1.1.0",
+    "types-setuptools",
+]
+test = [
+    "pytest==9.1.1",
+    "pytest-asyncio==1.4.0",
+    "pytest-timeout>=2.4.0",
+    "pytest-cov>=6.2.1",
+    "covdefaults>=2.3.0",
+    "coverage[toml]==7.14.1",
+]
+docs = ["zensical==0.0.45"]
+dev = [
+    { include-group = "lint" },
+    { include-group = "test" },
+    { include-group = "docs" },
+    "detect-secrets==1.5.0",
+    "prek==0.4.5",
+]
+
+[project.urls]
+Homepage = "https://theseriff.github.io/zspeedtest/"
+Repository = "https://github.com/theseriff/zspeedtest"
+Documentation = "https://theseriff.github.io/zspeedtest/"
+Changelog = "https://github.com/theseriff/zspeedtest/blob/main/docs/CHANGELOG.md"
+Issues = "https://github.com/theseriff/zspeedtest/issues"
+
+# Tests
+[tool.pytest.ini_options]
+xfail_strict = true
+timeout = 10
+addopts = "--strict-markers --strict-config"
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "session"
+filterwarnings = []
+markers = []
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+relative_files = true
+parallel = true
+branch = true
+concurrency = ["thread", "multiprocessing"]
+source = ["src", "tests"]
+omit = ["**/__init__.py"]
+
+[tool.coverage.paths]
+source = ["src"]
+tests = ["tests"]
+
+[tool.coverage.report]
+fail_under = 100
+skip_empty = true
+show_missing = true
+exclude_also = [
+    'if TYPE_CHECKING:',
+    "if __name__ == .__main__.:",
+    '@()?abstractmethod',
+    "raise NotImplementedError",
+    "pass",
+    '\.\.\.',
+]
+omit = ["*/__init__.py", '*/types.py']
+
+# Static Analysis
+[tool.ty.environment]
+python-version = "3.10"
+
+[tool.ty.src]
+include = ["src", "tests"]
+
+[tool.ty.rules]
+all = "error"
+unresolved-attribute = "ignore"
+
+[tool.ty.analysis]
+respect-type-ignore-comments = false
+
+[tool.ty.terminal]
+error-on-warning = true
+output-format = "concise"
+
+[tool.mypy]
+mypy_path = "src"
+files = ["src", "tests"]
+python_version = "3.10"
+strict = true
+pretty = true
+warn_return_any = true
+warn_unreachable = true
+warn_unused_ignores = true
+warn_redundant_casts = true
+allow_redefinition = true
+allow_untyped_calls = true
+disallow_any_explicit = false
+disallow_any_generics = false
+disallow_subclassing_any = false
+disallow_untyped_decorators = false
+show_error_codes = true
+show_error_context = true
+show_column_numbers = true
+check_untyped_defs = true
+namespace_packages = true
+ignore_missing_imports = true
+
+[tool.semgrep]
+paths = ["src"]
+include = ["src"]
+
+[tool.bandit]
+targets = "src"
+
+# Liter
+[tool.ruff]
+src = ["src"]
+include = ["src/**.py", "tests/**.py"]
+target-version = "py310"
+line-length = 79
+fix = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D203",   # Conflict: D203 ("one-blank-line-before-class-docstring") is incompatible with D211 (No blank line before class docstring). We follow D211.
+    "D213",   # Conflict: D213 ("multi-line summary second line") conflicts with D212 (summary on the same line as triple quotes). We follow D212.
+    "COM812", # Conflict: Danger! This rule ("trailing-comma-missing") conflicts with the automatic behavior of "ruff format", which manages trailing commas.
+    "SLF001",
+    "T201",   # print
+    "RUF001", # cyrillic
+    "D",
+    "S310",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["S101", "D", "SLF001", "TID251", "PLR2004"]
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint.isort]
+known-first-party = ["src", "tests"]
+no-lines-before = ["local-folder"]
+
+[tool.codespell]
+skip = "*.pyi,*.pyc,./site"
+
+# Python Semantic Release
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+commit_parser = "conventional"
+build_command = """
+    uv lock --upgrade-package zspeedtest
+    git add uv.lock
+    uv build
+"""
+tag_format = "v{version}"
+major_on_zero = false
+allow_zero_version = true
+commit_message = "chore(release): release v{version} [skip ci]"
+
+[tool.semantic_release.commit_parser_options]
+major_tags = ["BREAKING CHANGE"]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]
+parse_squash_commits = true
+ignore_merge_commits = true
+
+[tool.semantic_release.changelog]
+# Recommended patterns for conventional commits parser that is scope aware
+exclude_commit_patterns = [
+    '''Initial [Cc]ommit.*''',         # codespell:ignore ommit
+    '''refactor(?:\([^)]*?\))?: .+''',
+    '''polish(?:\([^)]*?\))?: .+''',
+    '''style(?:\([^)]*?\))?: .+''',
+    '''chore(?:\([^)]*?\))?: .+''',
+    '''build\((?!deps\): .+)''',
+    '''test(?:\([^)]*?\))?: .+''',
+    '''ci(?:\([^)]*?\))?: .+''',
+    '''Merged? .*''',
+]
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "docs/CHANGELOG.md"
+mask_initial_release = true
+
+[tool.semantic_release.publish]
+dist_glob_patterns = ["dist/*"]
+upload_to_vcs_release = true
+
+[tool.semantic_release.remote]
+type = "github"
+ignore_token_for_push = true

zspeedtest-0.1.1/src/zspeedtest/__init__.py

@@ -0,0 +1,5 @@
+"""Core zspeedtest components for the zspeedtest library."""
+
+from importlib.metadata import version as get_version
+
+__version__ = get_version("zspeedtest")

zspeedtest-0.1.1/src/zspeedtest/main.py

@@ -0,0 +1,149 @@
+"""Internet speed tester.
+
+Usage: zspeedtest <URL> [--requests N]
+"""
+
+import argparse
+import sys
+import textwrap
+import time
+from typing import NamedTuple
+from urllib.request import Request, urlopen
+
+KB = 1024
+MB = KB**2
+CHUNK_SIZE = KB * 64
+DEFAULT_URL = "http://ipv4.download.thinkbroadband.com/10MB.zip"
+
+
+class SpeedTestArgs(NamedTuple):
+    url: str
+    requests: int
+    timeout: int
+
+    @classmethod
+    def from_cli(cls) -> "SpeedTestArgs":
+        parser = argparse.ArgumentParser(
+            description="Internet speed tester",
+            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        )
+        parser.add_argument(
+            "url",
+            nargs="?",
+            default=DEFAULT_URL,
+            help="URL of a large file to download",
+        )
+        parser.add_argument(
+            "--requests",
+            "-n",
+            type=int,
+            default=10,
+            metavar="N",
+            help="Number of requests",
+        )
+        parser.add_argument(
+            "--timeout",
+            "-t",
+            type=int,
+            default=30,
+            metavar="N",
+            help="Request timeout",
+        )
+        namespace = parser.parse_args()
+
+        if not namespace.url.startswith(("http:", "https:")):
+            msg = "URL must start with 'http:' or 'https:'"
+            raise ValueError(msg)
+
+        return cls(**namespace.__dict__)
+
+
+class RequestResult(NamedTuple):
+    duration_seconds: float
+    bytes_downloaded: int
+
+
+def download_url(req: Request, timeout: int) -> RequestResult:
+    start = time.perf_counter()
+    total_bytes: int = 0
+
+    # nosemgrep: python.lang.security.audit.dynamic-urllib-use-detected.dynamic-urllib-use-detected  # noqa: E501, ERA001
+    with urlopen(req, timeout=timeout) as response:  # nosec
+        while chunk := response.read(CHUNK_SIZE):
+            total_bytes += len(chunk)
+
+    duration = time.perf_counter() - start
+    return RequestResult(
+        duration_seconds=duration,
+        bytes_downloaded=total_bytes,
+    )
+
+
+def format_size(bytes_count: float) -> str:
+    for unit in ("B", "KB", "MB", "GB"):
+        if bytes_count < KB:
+            return f"{bytes_count:.1f} {unit}"
+        bytes_count /= KB
+    return f"{bytes_count:.1f} TB"
+
+
+def run() -> None:
+    args = SpeedTestArgs.from_cli()
+    start_info = textwrap.dedent(f"""\
+        URL: {args.url}
+        Requests: {args.requests}
+        {"-" * 52}
+        {"#":>3}  {"Size":>10}  {"Time":>8}  {"Speed":>12}
+        {"-" * 52}
+    """)
+    print(start_info)
+
+    results: list[RequestResult] = []
+
+    req = Request(args.url)
+    req.add_header("User-Agent", "zspeedtest/1.0")
+
+    for i in range(1, args.requests + 1):
+        try:
+            r = download_url(req, timeout=args.timeout)
+        except Exception as e:  # noqa: BLE001
+            print(f"{i:>3}  ERROR: {e}")
+            continue
+
+        results.append(r)
+
+        speed_mbps = (r.bytes_downloaded / r.duration_seconds) / MB
+        print(
+            f"{i:>3}  {format_size(r.bytes_downloaded):>10}"
+            f"  {r.duration_seconds:>7.2f}s  {speed_mbps:>10.2f} MB/s"
+        )
+
+    if not results:
+        print("\nNo requests completed successfully.")
+        sys.exit(1)
+
+    print("=" * 52)
+
+    total_bytes = sum(r.bytes_downloaded for r in results)
+    total_time = sum(r.duration_seconds for r in results)
+    avg_time = total_time / len(results)
+    avg_speed = (total_bytes / total_time) / MB
+    min_speed = min(
+        (r.bytes_downloaded / r.duration_seconds) / MB for r in results
+    )
+    max_speed = max(
+        (r.bytes_downloaded / r.duration_seconds) / MB for r in results
+    )
+
+    end_info = textwrap.dedent(f"""\
+        Successful requests : {len(results)} / {args.requests}
+        Total downloaded    : {format_size(total_bytes)}
+        Average time        : {avg_time:.2f} s
+        Average speed       : {avg_speed:.2f} MB/s
+        Min / Max           : {min_speed:.2f} / {max_speed:.2f} MB/s
+    """)
+    print(end_info)
+
+
+if __name__ == "__main__":
+    run()