http-checker 1.5.0__py3-none-any.whl

http_checker/checker.py

@@ -0,0 +1,57 @@
+import logging
+import requests
+from typing import Collection
+
+logger = logging.getLogger(__name__)
+
+
+def check_urls(
+    urls: Collection[str], timeout: int = 5
+) -> dict[str, str]:
+    """
+    Checks a list of URLs and returns their status.
+
+    Args:
+        urls: A list of URL strings to check.
+        timeout: Maximum time in seconds to wait for each request. Defaults to 5.
+
+    Returns:
+        A dictionary mapping each URL to its status string.
+    """
+
+    logger.info(
+        f"Starting check for {len(urls)} URLs with a timeout of {timeout}"
+    )
+    results: dict[str, str] = {}
+
+    for url in urls:
+        status = "UNKNOWN"
+
+        try:
+            logger.debug(f"Checking URL: {url}")
+            response = requests.get(url, timeout=timeout)
+
+            if response.ok:
+                status = f"{response.status_code} OK"
+            else:
+                status = (
+                    f"{response.status_code} {response.reason}"
+                )
+        except requests.exceptions.Timeout:
+            status = "TIMEOUT"
+            logger.warning(f"Request to {url} timed out.")
+        except requests.exceptions.ConnectionError:
+            status = "CONNECTION_ERROR"
+            logger.warning(f"Connection error for {url}.")
+        except requests.exceptions.RequestException as e:
+            status = f"REQUEST_ERROR: {type(e).__name__}"
+            logger.error(
+                f"An unexpected request error occured for {url}: {e}",
+                exc_info=True,
+            )
+
+        results[url] = status
+        logger.debug(f"Checked: {url:<40} -> {status}")
+
+    logger.info("URL check finished.")
+    return results

http_checker/cli.py

@@ -0,0 +1,54 @@
+import logging
+import click
+from .checker import check_urls
+from typing import Collection
+
+logging.basicConfig(
+    level=logging.INFO,
+    format="[%(asctime)s] %(levelname)-8s %(name)s: %(message)s",
+    datefmt="%Y-%m-%d %H:%M:%S",
+)
+
+logger = logging.getLogger(__name__)
+
+
+@click.command()
+@click.argument("urls", nargs=-1)
+@click.option(
+    "--timeout",
+    default=5,
+    help="Timeout for each URL check in seconds.",
+)
+@click.option(
+    "--verbose",
+    "-v",
+    is_flag=True,
+    help="Enable verbose logging.",
+)
+def main(urls: Collection[str], timeout: int, verbose: bool):
+
+    if verbose:
+        logging.getLogger().setLevel(logging.DEBUG)
+        logger.debug("Verbose logging enabled.")
+
+    logger.debug(f"Received urls: {urls}")
+    logger.debug(f"Received timeout: {timeout}")
+    logger.debug(f"Received verbose flag: {verbose}")
+
+    if not urls:
+        logger.warning(
+            "No URLs provided. Please provide at least one URL to check."
+        )
+        click.echo("Usage: check-urls <URL1> <URL2> ...")
+        return
+
+    logger.info(f"Starting check for {len(urls)} URLs.")
+    results = check_urls(urls, timeout)
+
+    click.echo("\n --- Results ----")
+    for url, status in results.items():
+        if "OK" in status:
+            fg_color = "green"
+        else:
+            fg_color = "red"
+        click.secho(f"{url:<40} -> {status}", fg=fg_color)

http_checker-1.5.0.dist-info/METADATA

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: http-checker
+Version: 1.5.0
+Summary: A simple CLI tool to check the status of URLs.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.28
+Requires-Dist: click<9.0,>=8.0
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: types-requests; extra == "dev"
+Dynamic: license-file
+
+## Implementaion
+
+[x] Project files (code files)
+[x] Add simple GHA workflow and make sure it runs completion
+[x] Add linting (ruff) and format checks (black)
+[] Add typing and security checks
+[] Add test automation
+[] Build our Python project
+[] Publish the project to bet TestPyPi and PyPi when a new tag is pushed

http_checker-1.5.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+http_checker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+http_checker/checker.py,sha256=T9J20gUFSuss-T6MfFO_8LD6jGAxOE4Q9jiE0ZAHuIc,1664
+http_checker/cli.py,sha256=WjYsXVReNO77IWqyuBdrCN32icSyUMtTwWAblbTTONc,1389
+http_checker-1.5.0.dist-info/licenses/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+http_checker-1.5.0.dist-info/METADATA,sha256=pPaCriXrkzD7LYhRRSIuR_9C424RSvbmoG6AdoEPFJM,897
+http_checker-1.5.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+http_checker-1.5.0.dist-info/entry_points.txt,sha256=qlCEGCd28UEdZVS_9DlBhJnXRfLDcauT4kkhYv41Kek,53
+http_checker-1.5.0.dist-info/top_level.txt,sha256=p_A8BMdCxxgJ3tG4OKL8MuB9hqcCHliOFczcX7LPTLg,13
+http_checker-1.5.0.dist-info/RECORD,,

http_checker-1.5.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

http_checker-1.5.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+check-urls = http_checker.cli:main

http_checker-1.5.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+http_checker