simple-http-checker-d-superteach 1.2.0__tar.gz

simple_http_checker_d_superteach-1.2.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,13 @@
+# 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/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "simple-http-checker-d-superteach"
+version = "1.2.0"
+description = "A simple CLI tool to check the status of URLs."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = ["requests>=2.34,<3.0", "click>=8.0,<9.0"]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-mock", "ruff", "black", "mypy", "bandit"]
+
+[project.scripts]
+check-urls = "simple_http_checker.cli:main"
+
+[tool.ruff]
+line-length = 88
+
+[tool.black]
+line-length = 88
+
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.bandit]
+exclude_dirs = [".venv", "__pycache__", "build", "dirs"]
+skips = ["B101"]
+
+[tool.pytest.ini_options]
+addopts = "-rA -s -v"
+
+[tool.semantic_release]
+version_toml = ["pyproject.toml:project.version"]
+build_command = "pip install build && python -m build"
+dist_path = "dist/"
+upload_to_pypi = false
+upload_to_release = true
+hvcs = "github"
+commit_message = "chore(release): {version} [skip ci]"
+
+[tool.semantic_release.branches.main]
+match = "main"
+prerelease = false
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG.md"
+
+[tool.semantic_release.commit_parser_options]
+allowed = [
+    "build",
+    "chore",
+    "ci",
+    "docs",
+    "feat",
+    "fix",
+    "perf",
+    "refactor",
+    "style",
+    "test",
+]
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]

simple_http_checker_d_superteach-1.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

simple_http_checker_d_superteach-1.2.0/src/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_d_superteach-1.2.0/src/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/src/simple_http_checker_d_superteach.egg-info/PKG-INFO

@@ -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/src/simple_http_checker_d_superteach.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/simple_http_checker/__init__.py
+src/simple_http_checker/checker.py
+src/simple_http_checker/cli.py
+src/simple_http_checker_d_superteach.egg-info/PKG-INFO
+src/simple_http_checker_d_superteach.egg-info/SOURCES.txt
+src/simple_http_checker_d_superteach.egg-info/dependency_links.txt
+src/simple_http_checker_d_superteach.egg-info/entry_points.txt
+src/simple_http_checker_d_superteach.egg-info/requires.txt
+src/simple_http_checker_d_superteach.egg-info/top_level.txt
+tests/test_checker.py
+tests/test_cli.py

simple_http_checker_d_superteach-1.2.0/src/simple_http_checker_d_superteach.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

simple_http_checker_d_superteach-1.2.0/src/simple_http_checker_d_superteach.egg-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/src/simple_http_checker_d_superteach.egg-info/requires.txt

@@ -0,0 +1,10 @@
+requests<3.0,>=2.34
+click<9.0,>=8.0
+
+[dev]
+pytest
+pytest-mock
+ruff
+black
+mypy
+bandit

simple_http_checker_d_superteach-1.2.0/src/simple_http_checker_d_superteach.egg-info/top_level.txt

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

simple_http_checker_d_superteach-1.2.0/tests/test_checker.py

@@ -0,0 +1,127 @@
+import pytest
+import requests
+from pytest_mock import MockerFixture
+
+from simple_http_checker.checker import check_urls
+
+
+def test_check_urls_success(mocker: MockerFixture) -> None:
+    mock_requests_get = mocker.patch("simple_http_checker.checker.requests.get")
+
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.status_code = 200
+    mock_response.reason = "OK"
+    mock_response.ok = True
+
+    mock_requests_get.return_value = mock_response
+
+    urls = ["https://www.example.com"]
+    results = check_urls(urls)
+
+    mock_requests_get.assert_called_once_with(urls[0], timeout=5)
+    assert results[urls[0]] == "200 OK"
+
+
+def test_check_urls_client_error(mocker: MockerFixture) -> None:
+    mock_requests_get = mocker.patch("simple_http_checker.checker.requests.get")
+
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.status_code = 404
+    mock_response.reason = "Not Found"
+    mock_response.ok = False
+
+    mock_requests_get.return_value = mock_response
+
+    urls = ["https://www.example.com/nonexistent"]
+    results = check_urls(urls)
+
+    mock_requests_get.assert_called_once_with(urls[0], timeout=5)
+    assert results[urls[0]] == "404 Not Found"
+
+
+@pytest.mark.parametrize(
+    "error_exception, expected_status",
+    [
+        (requests.exceptions.Timeout, "TIMEOUT"),
+        (requests.exceptions.ConnectionError, "CONNECTION_ERROR"),
+        (requests.exceptions.RequestException, "REQUEST_ERROR: RequestException"),
+    ],
+    # ids=["Timeout", "ConnectionError", "RequestException"],
+)
+def test_check_urls_requests_exceptions(
+    mocker: MockerFixture,
+    error_exception: type[requests.exceptions.RequestException],
+    expected_status: str,
+) -> None:
+    mock_requests_get = mocker.patch("simple_http_checker.checker.requests.get")
+
+    mock_requests_get.side_effect = error_exception(f"Simulated {expected_status}")
+
+    urls = ["https://www.problem.com"]
+    results = check_urls(urls)
+
+    mock_requests_get.assert_called_once_with(urls[0], timeout=5)
+    assert results[urls[0]] == expected_status
+
+
+def test_check_urls_with_multiple_urls(mocker: MockerFixture) -> None:
+    mock_requests_get = mocker.patch("simple_http_checker.checker.requests.get")
+
+    # First call: OK
+    mock_response_ok = mocker.MagicMock(spec=requests.Response)
+    mock_response_ok.status_code = 200
+    mock_response_ok.reason = "OK"
+    mock_response_ok.ok = True
+
+    # Second call: Timeout
+    timeout_exception = requests.exceptions.Timeout("Simulated timeout")
+
+    # Third call: 500 Server Error
+    mock_response_fail = mocker.MagicMock(spec=requests.Response)
+    mock_response_fail.status_code = 500
+    mock_response_fail.reason = "Server Error"
+    mock_response_fail.ok = False
+
+    # Set (return_value, actually side_effect) to a list of the 3 calls
+    # i.e., call the mock 3 times by passing 3 URLs
+    mock_requests_get.side_effect = [
+        mock_response_ok,
+        timeout_exception,
+        mock_response_fail,
+    ]
+
+    urls = [
+        "https://www.success.com",
+        "https://www.timeout.com",
+        "https://www.servererror.com",
+    ]
+    results = check_urls(urls)
+
+    assert len(results) == 3
+    assert mock_requests_get.call_count == 3
+    assert results["https://www.success.com"] == "200 OK"
+    assert results["https://www.timeout.com"] == "TIMEOUT"
+    assert results["https://www.servererror.com"] == "500 Server Error"
+
+
+def test_check_urls_empty_list() -> None:
+    results = check_urls([])
+    assert results == {}
+
+
+def test_check_urls_custom_timeout(mocker: MockerFixture) -> None:
+    mock_requests_get = mocker.patch("simple_http_checker.checker.requests.get")
+
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.status_code = 200
+    mock_response.reason = "OK"
+    mock_response.ok = True
+
+    mock_requests_get.return_value = mock_response
+
+    urls = ["https://www.example.com"]
+    custom_timeout = 10
+    results = check_urls(urls, timeout=custom_timeout)
+
+    mock_requests_get.assert_called_once_with(urls[0], timeout=custom_timeout)
+    assert results[urls[0]] == "200 OK"

simple_http_checker_d_superteach-1.2.0/tests/test_cli.py

@@ -0,0 +1,76 @@
+from click.testing import CliRunner
+from pytest_mock import MockerFixture
+
+from simple_http_checker.cli import main
+
+
+def test_main_no_url() -> None:
+    runner = CliRunner()
+    result = runner.invoke(main, [])
+
+    assert result.exit_code == 0
+    assert "Usage: check-urls" in result.output
+
+
+def test_main_single_url_success(mocker: MockerFixture) -> None:
+    url = "https://www.example.com"
+    mock_check_urls = mocker.patch("simple_http_checker.cli.check_urls")
+    mock_check_urls.return_value = {url: "200 OK"}
+
+    runner = CliRunner()
+    result = runner.invoke(main, [url])
+
+    # For line below: click collects pos-args into a tuple (url,), not a list [url]
+    mock_check_urls.assert_called_once_with((url,), timeout=5)
+    assert result.exit_code == 0
+
+    assert "--- RESULTS ---" in result.output
+    assert url in result.output
+    assert "-> 200 OK" in result.output
+
+
+def test_main_custom_timeout(mocker: MockerFixture) -> None:
+    url = "https://www.timeout.com"
+    mock_check_urls = mocker.patch("simple_http_checker.cli.check_urls")
+    mock_check_urls.return_value = {url: "TIMEOUT"}
+
+    runner = CliRunner()
+    result = runner.invoke(main, [url, "--timeout", "10"])
+
+    mock_check_urls.assert_called_once_with((url,), timeout=10)
+    assert result.exit_code == 0
+
+    assert "--- RESULTS ---" in result.output
+    assert url in result.output
+    assert "-> TIMEOUT" in result.output
+
+
+def test_main_multiple_urls(mocker: MockerFixture) -> None:
+    urls = (
+        "https://www.example1.com",
+        "https://www.example2.com",
+        "https://www.clienterror.com",
+        "https://www.servererror.com",
+    )
+    mock_check_urls = mocker.patch("simple_http_checker.cli.check_urls")
+    mock_check_urls.return_value = {
+        urls[0]: "200 OK",
+        urls[1]: "200 OK",
+        urls[2]: "404 Client Error",
+        urls[3]: "504 Server Error",
+    }
+
+    runner = CliRunner()
+    result = runner.invoke(main, urls)
+
+    mock_check_urls.assert_called_once_with(urls, timeout=5)
+    assert result.exit_code == 0
+
+    assert "--- RESULTS ---" in result.output
+    assert urls[0] in result.output
+    assert urls[1] in result.output
+    assert urls[2] in result.output
+    assert urls[3] in result.output
+    assert "-> 200 OK" in result.output
+    assert "-> 404 Client Error" in result.output
+    assert "-> 504 Server Error" in result.output