simple2-http-checking 1.0.0__tar.gz

simple2_http_checking-1.0.0/LICENSE

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

simple2_http_checking-1.0.0/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: simple2-http-checking
+Version: 1.0.0
+Summary: A simple CLI tool to check the status of URLs.
+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
+
+# Python Projects: CI/CD
+This repo contains  the code for the CI/CD sections of my Python for Devops course.
+
+## What we implement in this repository
+
+[] Implement the project (code files)
+
+[] Add a simple GHA workflow and make sure it runs until completion
+
+[] Add linting (ruff) and format checks (black)
+
+[] Add typing (mypy) and security checks (bandit)
+
+[] Add test automation
+
+[] Build our Python project
+
+[] Publish the project to both TestPyPi and Pypi when a new release is published

simple2_http_checking-1.0.0/README.md

@@ -0,0 +1,18 @@
+# Python Projects: CI/CD
+This repo contains  the code for the CI/CD sections of my Python for Devops course.
+
+## What we implement in this repository
+
+[] Implement the project (code files)
+
+[] Add a simple GHA workflow and make sure it runs until completion
+
+[] Add linting (ruff) and format checks (black)
+
+[] Add typing (mypy) and security checks (bandit)
+
+[] Add test automation
+
+[] Build our Python project
+
+[] Publish the project to both TestPyPi and Pypi when a new release is published

simple2_http_checking-1.0.0/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = ["setuptools>=77.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "simple2-http-checking"
+version = "1.0.0"
+description = "A simple CLI tool to check the status of URLs."
+readme = "README.md"
+dependencies = [
+  "requests>=2.28,<3.0",
+  "click>=8.0,<9.0"
+]
+
+[project.optional-dependencies]
+dev = [
+  "pytest",
+  "pytest-mock",
+  "ruff",
+  "black",
+  "mypy",
+  "bandit",
+  "types-requests"
+]
+
+[project.scripts]
+check-urls = "simple_http_checker.cli:main"
+
+[tool.ruff]
+line-length = 65
+[tool.black]
+line-length = 65
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+[tool.bandit]
+exclude_dirs = [".venv", "__pycache__", "build", "dist"]
+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_tags = [
+  "build",
+  "chore",
+  "ci",
+  "docs",
+  "feat",
+  "fix",
+  "pref",
+  "style",
+  "refactor",
+  "test"
+]
+
+minor_tags = ["feat"]
+patch_tags = ["fix", "perf"]

simple2_http_checking-1.0.0/setup.cfg

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

simple2_http_checking-1.0.0/src/simple2_http_checking.egg-info/PKG-INFO

@@ -0,0 +1,36 @@
+Metadata-Version: 2.4
+Name: simple2-http-checking
+Version: 1.0.0
+Summary: A simple CLI tool to check the status of URLs.
+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
+
+# Python Projects: CI/CD
+This repo contains  the code for the CI/CD sections of my Python for Devops course.
+
+## What we implement in this repository
+
+[] Implement the project (code files)
+
+[] Add a simple GHA workflow and make sure it runs until completion
+
+[] Add linting (ruff) and format checks (black)
+
+[] Add typing (mypy) and security checks (bandit)
+
+[] Add test automation
+
+[] Build our Python project
+
+[] Publish the project to both TestPyPi and Pypi when a new release is published

simple2_http_checking-1.0.0/src/simple2_http_checking.egg-info/SOURCES.txt

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

simple2_http_checking-1.0.0/src/simple2_http_checking.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

simple2_http_checking-1.0.0/src/simple2_http_checking.egg-info/entry_points.txt

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

simple2_http_checking-1.0.0/src/simple2_http_checking.egg-info/requires.txt

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

simple2_http_checking-1.0.0/src/simple2_http_checking.egg-info/top_level.txt

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

simple2_http_checking-1.0.0/src/simple_http_checker/checker.py

@@ -0,0 +1,54 @@
+import logging
+
+import requests
+
+logger = logging.getLogger(__name__)
+
+
+def check_urls(
+    urls: list[str], timeout: int = 5
+) -> dict[str, str]:
+    """
+    Check the status of a list of URLs.
+
+    Args:
+        urls: A list of URLs to check.
+        timeout: The timeout for each HTTP request, in seconds.
+
+    Returns:
+        A dictionary mapping each URL to its status
+        (an HTTP status code, or a short error description).
+    """
+    logger.info(
+        f"Checking {len(urls)} URLs with a timeout of {timeout} seconds."
+    )
+    results: dict[str, str] = {}
+
+    for url in urls:
+        try:
+            logger.debug(f"Checking URL: {url}")
+            response = requests.get(url, timeout=timeout)
+
+            if response.ok:
+                status = str(response.status_code)
+            else:
+                status = (
+                    f"{response.status_code} - {response.reason}"
+                )
+        except requests.exceptions.Timeout:
+            status = "TIMEOUT"
+            logger.warning(f"Timeout occurred for URL: {url}")
+        except requests.exceptions.ConnectionError:
+            status = "CONNECTION ERROR"
+            logger.warning(
+                f"Connection error occurred for URL: {url}"
+            )
+        except requests.exceptions.RequestException as e:
+            status = f"ERROR - {type(e).__name__}"
+            logger.exception(f"Request exception for URL: {url}")
+
+        results[url] = status
+        logger.debug(f"Checked: {url:<40} Status: {status}")
+
+    logger.info("URL checking completed.")
+    return results

simple2_http_checking-1.0.0/src/simple_http_checker/cli.py

@@ -0,0 +1,63 @@
+import logging
+import sys
+from _collections_abc import Collection
+
+import click
+
+from simple_http_checker.checker import check_urls
+
+logger = logging.getLogger(__name__)
+
+
+@click.command(
+    name="check_urls",
+    help="Check the status of one or more URLs.",
+)
+@click.argument("urls", nargs=-1, required=True)
+@click.option(
+    "--timeout",
+    type=click.IntRange(min=1),
+    default=5,
+    show_default=True,
+    help="Timeout for each request, in seconds.",
+)
+@click.option(
+    "--verbose",
+    "-v",
+    is_flag=True,
+    help="Show detailed debug logs.",
+)
+def main(urls: Collection[str], timeout: int, verbose: bool):
+    """Check the status of one or more URLs."""
+    logging.basicConfig(
+        level=logging.DEBUG if verbose else logging.WARNING,
+        format="%(levelname)s:%(name)s:%(message)s",
+        force=True,
+    )
+    if verbose:
+        logging.getLogger().setLevel(logging.DEBUG)
+        logger.debug("Verbose mode enabled.")
+    logger.debug(f"Received urls: {urls}")
+    logger.debug(f"Received timeout: {timeout} seconds")
+    logger.debug(f"Received verbose flag: {verbose}")
+    if not urls:
+        logger.error("No URLs provided.")
+        click.echo("Error: No URLs provided.", err=True)
+        sys.exit(1)
+    results = check_urls(list(urls), timeout=timeout)
+
+    failed = 0
+    for url, status in results.items():
+        ok = status.isdigit()
+        if not ok:
+            failed += 1
+        click.secho(
+            f"{url:<40} {status}", fg="green" if ok else "red"
+        )
+
+    click.echo(
+        f"\n{len(results) - failed}/{len(results)} URLs OK"
+    )
+
+    if failed:
+        sys.exit(1)

simple2_http_checking-1.0.0/tests/test_checker.py

@@ -0,0 +1,115 @@
+import pytest
+import requests
+from pytest_mock import MockerFixture
+
+from simple_http_checker.checker import check_urls
+
+
+def test_check_urls_success(mocker: MockerFixture):
+    # Mock the requests.get method to simulate a successful response
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.ok = True
+    mock_response.status_code = 200
+    mock_response.reason = "OK"
+    mocker.patch(
+        "simple_http_checker.checker.requests.get",
+        return_value=mock_response,
+    )
+
+    urls = ["http://example.com"]
+    results = check_urls(urls)
+
+    assert results == {"http://example.com": "200"}
+
+
+def test_check_urls_client_error(mocker: MockerFixture):
+    # Mock the requests.get method to simulate a client error response
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.ok = False
+    mock_response.status_code = 404
+    mock_response.reason = "Not Found"
+    mocker.patch(
+        "simple_http_checker.checker.requests.get",
+        return_value=mock_response,
+    )
+
+    urls = ["http://example.com/nonexistent"]
+    results = check_urls(urls)
+
+    assert results == {
+        "http://example.com/nonexistent": "404 - Not Found"
+    }
+
+
+@pytest.mark.parametrize(
+    "error_exception, expected_status",
+    [
+        (requests.exceptions.Timeout, "TIMEOUT"),
+        (
+            requests.exceptions.ConnectionError,
+            "CONNECTION ERROR",
+        ),
+        (
+            requests.exceptions.RequestException,
+            "ERROR - RequestException",
+        ),
+    ],
+)
+def test_check_urls_exception(
+    mocker: MockerFixture,
+    error_exception: Exception,
+    expected_status: str,
+):
+    # Mock the requests.get method to raise a RequestException
+    mocker.patch(
+        "simple_http_checker.checker.requests.get",
+        side_effect=requests.exceptions.RequestException,
+    )
+
+    urls = ["http://MYDOG.com"]
+    results = check_urls(urls)
+
+    assert results == {
+        "http://MYDOG.com": "ERROR - RequestException"
+    }
+
+
+def test_check_urls_with_multiple_urls(mocker: MockerFixture):
+    # Mock the requests.get method to simulate successful responses
+    mock_response = mocker.MagicMock(spec=requests.Response)
+    mock_response.ok = True
+    mock_response.status_code = 200
+    mock_response.reason = "OK"
+    mocker.patch(
+        "simple_http_checker.checker.requests.get",
+        return_value=mock_response,
+    )
+
+    urls = ["http://example.com", "http://mydog.com"]
+    results = check_urls(urls)
+
+    assert results == {
+        "http://example.com": "200",
+        "http://mydog.com": "200",
+    }
+
+
+def test_check_urls_empty_list(mocker: MockerFixture):
+    # Test with an empty list of URLs
+    urls = []
+    results = check_urls(urls)
+
+    assert results == {}
+
+
+def test_check_urls_timeout(mocker: MockerFixture):
+    # Mock the requests.get method to raise a Timeout exception
+    mocker.patch(
+        "simple_http_checker.checker.requests.get",
+        side_effect=requests.exceptions.Timeout,
+    )
+
+    urls = ["http://example.com"]
+    results = check_urls(urls)
+
+    assert results == {"http://example.com": "TIMEOUT"}