simple-http-checker-d-superteach 1.2.0__py3-none-any.whl

simple_http_checker/checker.py

@@ -0,0 +1,53 @@
+import logging
+from collections.abc import Collection
+
+import requests
+
+logger = logging.getLogger(__name__)
+
+# Uncomment line below to showcase workflow fail -> security check error from bandit
+# API_TOKEN = "ghp_ThisLooksLikeAPersonalGitHubAccessToken"
+
+
+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 URLs to check.
+        timeout: Maximum time in seconds to wait for each request. Defaults to 5.
+
+    Return:
+        A dictionary mapping each URL to its status string.
+    """
+
+    logger.info(f"Starting check for {len(urls)} URLs with a timeout of {timeout} s.")
+    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)
+            logger.exception(f"An unexpected request error occured for {url}")
+        results[url] = status
+        logger.debug(f"Checked {url:<40} -> {status}")
+
+    logger.info("URL check finished.")
+    return results

simple_http_checker/cli.py

@@ -0,0 +1,50 @@
+import logging
+from collections.abc import Collection
+
+import click
+
+from .checker import check_urls
+
+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", "-t", default=5, help="Timeout in seconds for each request.")
+@click.option("--verbose", "-v", is_flag=True, help="Enable debug 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: {verbose}")
+
+    if not urls:
+        logger.warning("No URLs provided to check.")
+        click.echo("Usage: check-urls <URL1> <URL2> ...")
+        return
+
+    logger.info(f"Starting check for {len(urls)} URLs.")
+
+    results = check_urls(urls, timeout=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)
+
+
+# Example usage (in-terminal command)
+# pip install -e .
+# check-urls -vt10 https://www.google.com https://www.github.com https://www.aajdfhhjsdbgsjbndfjok.com http://httpbin.org/status/404

simple_http_checker_d_superteach-1.2.0.dist-info/METADATA

@@ -0,0 +1,31 @@
+Metadata-Version: 2.4
+Name: simple-http-checker-d-superteach
+Version: 1.2.0
+Summary: A simple CLI tool to check the status of URLs.
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.34
+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"
+Dynamic: license-file
+
+# Python for DevOps: CI/CD for Python Projects
+
+This repo contains the code for the CI/CD section of my Python for DevOps course.
+
+## What we implement in this project
+
+- [x] Implement the project (code files)
+- [x] Add a simple GHA workflow and make sure it runs until completion
+- [x] Add lint (`ruff`) and format (`black`) checks
+- [x] Add type (`mypy`) and security (`bandit`) checks
+- [x] Add test automation
+- [x] Build the project
+- [ ] Publish the project to both `TestPyPI` and `PyPI` when a new tag is pushed

simple_http_checker_d_superteach-1.2.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+simple_http_checker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+simple_http_checker/checker.py,sha256=l4RC68AvC5Ho75-WDujgT4usvQTjf_MYK6w2sWP58L8,1787
+simple_http_checker/cli.py,sha256=_5-gs9V70Z6CtiOaF7BH5fLPBT2G4W72sMHzfNf_8B8,1506
+simple_http_checker_d_superteach-1.2.0.dist-info/licenses/LICENSE,sha256=oylYHUxyiLBg-N9AdyHUmY9y2VN5N6P-e9EkDcbA__0,1063
+simple_http_checker_d_superteach-1.2.0.dist-info/METADATA,sha256=Y3HrFlIsft7_LIE8zJ5JQlLZ34QRclBa7FvxGGTH-Gs,1074
+simple_http_checker_d_superteach-1.2.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+simple_http_checker_d_superteach-1.2.0.dist-info/entry_points.txt,sha256=UF_7hQD8GGstiCxqZgH6XC6YbiUxh7ZDf5o8Wg0NhDE,60
+simple_http_checker_d_superteach-1.2.0.dist-info/top_level.txt,sha256=Q2N-cYyXd23OQxUK_TdugtDVBHGsKaM2V2JOF5ygKtk,20
+simple_http_checker_d_superteach-1.2.0.dist-info/RECORD,,

simple_http_checker_d_superteach-1.2.0.dist-info/WHEEL

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

simple_http_checker_d_superteach-1.2.0.dist-info/entry_points.txt

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

simple_http_checker_d_superteach-1.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 mvpris
+
+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.

simple_http_checker_d_superteach-1.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+simple_http_checker