Merge pull request #28 from frankovo/release/0.3.1

refactor pyproject.toml cli.py analysis.py readme.md readme-pypi.md

Author: frankovo

README-pypi.md

@@ -1,10 +1,8 @@
-<div align="center">
-
-# DNS Benchmark Tool
-
-**Fast, comprehensive DNS performance testing**
-
-Part of [BuildTools](https://buildtools.net) - Network Performance Suite
+<p align="center">
+  <h1>DNS Benchmark Tool</h1>
+  <strong>Fast, comprehensive DNS performance testing</strong><br>
+  Part of <a href="https://buildtools.net">BuildTools</a> - Network Performance Suite
+</p>
 
 ```bash
 pip install dns-benchmark-tool
@@ -15,15 +13,17 @@ dns-benchmark benchmark --use-defaults
 
 > 🎉 **1,400+ downloads this week!** Thank you to our growing community.  
 
-**Real Time Tracking**
-
-![Real Time Tracking](https://raw.githubusercontent.com/frankovo/dns-benchmark-tool/main/docs/real_time_tracking.gif)
-*Watch DNS queries in motion*
-
-</div>
+</p>
 
 ---
 
+<p align="center">
+  <strong>Real Time Tracking</strong> <br>
+  <img src="https://raw.githubusercontent.com/frankovo/dns-benchmark-tool/main/docs/real_time_tracking.gif" alt="Real Time Tracking">
+  <br>
+  <span>Watch DNS queries in motion</span>
+</p>
+
 ## 🎉 Today’s Release Highlights ![new](https://img.shields.io/pypi/v/dns-benchmark-tool.svg?color=brightgreen&label=new)
 
 We’ve added **three powerful CLI commands** to make DNS benchmarking even more versatile:
@@ -48,8 +48,8 @@ dns-benchmark monitoring --use-defaults --interval 30 --duration 3600 \
 [![Publish to TestPyPI](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/testpypi.yml/badge.svg)](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/testpypi.yml)
 [![Publish to PyPI](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/pypi.yml/badge.svg)](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/pypi.yml)
 [![PyPI version](https://img.shields.io/pypi/v/dns-benchmark-tool.svg?color=brightgreen)](https://pypi.org/project/dns-benchmark-tool/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dns-benchmark-tool.svg)](https://pypi.org/project/dns-benchmark-tool/)
 
-![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)
 ![License](https://img.shields.io/badge/license-MIT-green.svg)
 ![Coverage](https://img.shields.io/badge/coverage-87%25-brightgreen.svg)
 

README.md

@@ -49,8 +49,8 @@ dns-benchmark monitoring --use-defaults --interval 30 --duration 3600 \
 [![Publish to TestPyPI](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/testpypi.yml/badge.svg)](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/testpypi.yml)
 [![Publish to PyPI](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/pypi.yml/badge.svg)](https://github.com/frankovo/dns-benchmark-tool/actions/workflows/pypi.yml)
 [![PyPI version](https://img.shields.io/pypi/v/dns-benchmark-tool.svg?color=brightgreen)](https://pypi.org/project/dns-benchmark-tool/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dns-benchmark-tool.svg)](https://pypi.org/project/dns-benchmark-tool/)
 
-![Python Version](https://img.shields.io/badge/python-3.9%2B-blue.svg)
 ![License](https://img.shields.io/badge/license-MIT-green.svg)
 ![Coverage](https://img.shields.io/badge/coverage-87%25-brightgreen.svg)
 

docs/real_time_tracking.gif

@@ -5,13 +5,14 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "dns-benchmark-tool"
 version = "0.3.0"
-description = "Benchmark DNS resolvers across domains and record types with analytics and reports (CSV, Excel, PDF, JSON)."
-readme = "README-pypi.md"
+description = "Fast, comprehensive DNS performance testing with DNSSEC validation, DoH/DoT support, and enterprise features."
+readme = { file = "README-pypi.md", content-type = "text/markdown" }
 authors = [
     { name = "Joseph Oseh Frank", email = "frank@osehfrank.com" }
 ]
 license = { text = "MIT" }
-requires-python = ">=3.9"
+requires-python = ">=3.9,<3.13"
+keywords = ["DNS", "benchmark", "performance", "DNSSEC", "DoH", "DoT", "networking", "latency", "resolver", "metrics"]
 
 dependencies = [
     "dnspython>=2.7,<3.0",       
@@ -26,7 +27,6 @@ dependencies = [
     "pyyaml>=6.0,<7.0",          
     "tqdm>=4.66,<5.0",           
     "matplotlib>=3.8,<4.0",
-    "seaborn>=0.13.2,<0.14.0",
     "pillow>=11.0.0,<12.0.0"
 ]
 
@@ -37,19 +37,22 @@ classifiers = [
     "Topic :: Internet :: Name Service (DNS)",
     "Topic :: System :: Networking",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
+    "Environment :: Console",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+    "Programming Language :: Python :: 3 :: Only",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
-    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.12"
 ]
 
 [project.urls]
 Homepage = "https://github.com/frankovo/dns-benchmark-tool"
 Documentation = "https://github.com/frankovo/dns-benchmark-tool#readme"
 Source = "https://github.com/frankovo/dns-benchmark-tool"
 Tracker = "https://github.com/frankovo/dns-benchmark-tool/issues"
+Changelog = "https://github.com/frankovo/dns-benchmark-tool/blob/main/CHANGELOG.md"
 
 [project.optional-dependencies]
 dev = [
@@ -64,7 +67,6 @@ dev = [
     "commitizen>=3.0,<5.0",
 ]
 
-
 [tool.setuptools.packages.find]
 where = ["src"]
 
@@ -88,7 +90,7 @@ strict = true
 
 [tool.black]
 line-length = 88
-target-version = ["py38", "py39", "py310", "py311", "py312"]
+target-version = ["py39", "py310", "py311", "py312"]
 
 [tool.isort]
 profile = "black"

pyproject.toml

@@ -102,14 +102,6 @@ def get_resolver_statistics(self) -> List[ResolverStats]:
                 cv = std_latency / avg_latency if avg_latency > 0 else 0
                 consistency_score = max(0, 100 - (cv * 100))
             else:
-                # min_latency = max_latency = avg_latency = median_latency = (
-                #     std_latency
-                # ) = 0.0
-                # p95_latency = p99_latency = jitter = consistency_score = 0.0
-                # No successful queries → mark latency as None
-                # min_latency = max_latency = avg_latency = median_latency = (
-                #     std_latency
-                # ) = None
                 min_latency = max_latency = avg_latency = median_latency = (
                     std_latency
                 ) = float("nan")

src/dns_benchmark/analysis.py

@@ -278,7 +278,7 @@ def reset_feedback() -> None:
     click.echo(click.style("✓ Feedback state reset", fg="green"))
 
 
-# Benchmark command
+# =================== Benchmark command
 @cli.command()
 @click.option("--resolvers", "-r", help="JSON file with resolver list")
 @click.option("--domains", "-d", help="Text file with domain list")
@@ -318,7 +318,6 @@ def reset_feedback() -> None:
 @click.option(
     "--include-charts", is_flag=True, help="Include charts in Excel and PDF exports"
 )
-# =================== Benchmark
 def benchmark(
     resolvers: Optional[str],
     domains: Optional[str],
@@ -622,6 +621,7 @@ def _progress_cb(completed: int, total: int) -> None:
         show_feedback_prompt()
 
 
+# ====================== Top Resolvers Command
 @cli.command()
 @click.option("--limit", "-n", default=10, help="Number of top resolvers to display")
 @click.option(
@@ -649,7 +649,6 @@ def _progress_cb(completed: int, total: int) -> None:
     "--output", "-o", help="Optional: save results to file (supports .txt, .json, .csv)"
 )
 @click.option("--quiet", is_flag=True, help="Suppress progress output")
-# ====================== Top
 def top(
     limit: int,
     metric: str,
@@ -930,8 +929,6 @@ def _progress_cb(completed: int, total: int) -> None:
 
 
 # ======================= Compare
-
-
 @cli.command()
 @click.argument("resolvers", nargs=-1, required=True)
 @click.option("--domains", "-d", help="Text file with domain list")
@@ -1191,6 +1188,7 @@ def _progress_cb(completed: int, total: int) -> None:
         raise
 
 
+# ==================== Monitoring Command
 @cli.command()
 @click.option("--resolvers", "-r", help="JSON file with resolver list")
 @click.option("--domains", "-d", help="Text file with domain list")
@@ -1219,7 +1217,6 @@ def _progress_cb(completed: int, total: int) -> None:
 @click.option(
     "--use-defaults", is_flag=True, help="Use default resolvers and sample domains"
 )
-# ==================== Monitoring
 def monitoring(
     resolvers: Optional[str],
     domains: Optional[str],
@@ -1389,6 +1386,7 @@ def monitoring(
             click.echo(success(f"Monitoring log saved to: {output}"))
 
 
+# ===================== List Defaults Command
 @cli.command()
 def list_defaults() -> None:
     """List default resolvers and sample domains."""
@@ -1404,6 +1402,7 @@ def list_defaults() -> None:
     return None
 
 
+# ===================== List Resolvers Command
 @cli.command()
 @click.option("--category", "-c", help="Filter by category")
 @click.option(
@@ -1516,6 +1515,7 @@ def list_resolvers(category: Optional[str], format: str, details: bool) -> None:
     click.echo(summary_box(summary_lines))
 
 
+# ====================== List Domains Command
 @cli.command()
 @click.option("--category", "-c", help="Filter by category")
 @click.option(
@@ -1593,6 +1593,7 @@ def list_domains(category: Optional[str], format: str, count: Optional[int]) ->
     click.echo(summary_box(summary_lines))
 
 
+# ======================= List Categories Command
 @cli.command()
 def list_categories() -> None:
     """Show all available resolver and domain categories"""
@@ -1626,6 +1627,7 @@ def list_categories() -> None:
     click.echo(summary_box(summary_lines))
 
 
+#  ====================== Generate Config Command
 @cli.command()
 @click.option("--category", "-c", help="Generate config for specific category")
 @click.option("--output", "-o", help="Output file path")

src/dns_benchmark/cli.py

@@ -92,15 +92,18 @@ def test_benchmark_exports_csv_excel_pdf_json(tmp_path, sample_results):
         "dns_benchmark.core.DNSQueryEngine.run_benchmark", return_value=sample_results
     ):
         # Also patch default resolvers/domains to keep totals small
-        with patch(
-            "dns_benchmark.core.ResolverManager.get_default_resolvers",
-            return_value=[
-                {"name": "Cloudflare", "ip": "1.1.1.1"},
-                {"name": "Google", "ip": "8.8.8.8"},
-            ],
-        ), patch(
-            "dns_benchmark.core.DomainManager.get_sample_domains",
-            return_value=["example.com", "bad-domain.test"],
+        with (
+            patch(
+                "dns_benchmark.core.ResolverManager.get_default_resolvers",
+                return_value=[
+                    {"name": "Cloudflare", "ip": "1.1.1.1"},
+                    {"name": "Google", "ip": "8.8.8.8"},
+                ],
+            ),
+            patch(
+                "dns_benchmark.core.DomainManager.get_sample_domains",
+                return_value=["example.com", "bad-domain.test"],
+            ),
         ):
             result = runner.invoke(
                 cli,

tests/test_benchmark_cli.py

@@ -7,16 +7,19 @@
 
 def test_list_defaults():
     runner = CliRunner()
-    with patch(
-        "dns_benchmark.core.ResolverManager.get_default_resolvers",
-        return_value=[
-            {"name": "Cloudflare", "ip": "1.1.1.1"},
-        ],
-    ), patch(
-        "dns_benchmark.core.DomainManager.get_sample_domains",
-        return_value=[
-            "example.com",
-        ],
+    with (
+        patch(
+            "dns_benchmark.core.ResolverManager.get_default_resolvers",
+            return_value=[
+                {"name": "Cloudflare", "ip": "1.1.1.1"},
+            ],
+        ),
+        patch(
+            "dns_benchmark.core.DomainManager.get_sample_domains",
+            return_value=[
+                "example.com",
+            ],
+        ),
     ):
         result = runner.invoke(cli, ["list-defaults"])
         assert result.exit_code == 0