Merge branch 'master' into pandas-concatenation-update

Author: gahjelle

python-site-connectivity-checker/README.md

@@ -0,0 +1,42 @@
+# Build a Site Connectivity Checker in Python
+
+RP Checker is a site connectivity checker utility. It takes one or more website URLs and checks if those sites are online. It can perform the connectivity checks either synchronously or asynchronously.
+
+## Installation
+
+1. Create a Python virtual environment
+
+```sh
+$ python -m venv ./venv
+$ source venv/bin/activate
+(venv) $
+```
+
+2. Install the requirements
+
+```
+(venv) $ python -m pip install -r requirements.txt
+```
+
+## Run the Project
+
+```sh
+(venv) $ python -m rpchecker -u python.org
+The status of "python.org" is: "Online!" 👍
+```
+
+## Features
+
+RP Checker provides the following options:
+
+- `-u` or `--urls` takes one or more URLs and checks if they're online.
+- `-f` or `--input-file` takes a file containing a list of URLs to check.
+- `-a` or `--asynchronous` runs the check asynchronously.
+
+## About the Author
+
+Leodanis Pozo Ramos - Email: [email protected]
+
+## License
+
+Distributed under the MIT license. See `LICENSE` in the root directory of this `materials` repo for more information.

python-site-connectivity-checker/sample-urls.txt

@@ -0,0 +1,4 @@
+python.org
+pypi.org
+docs.python.org
+peps.python.org

python-site-connectivity-checker/source_code_final/README.md

@@ -0,0 +1,42 @@
+# Build a Site Connectivity Checker in Python
+
+RP Checker is a site connectivity checker utility. It takes one or more website URLs and checks if those sites are online. It can perform the connectivity checks either synchronously or asynchronously.
+
+## Installation
+
+1. Create a Python virtual environment
+
+```sh
+$ python -m venv ./venv
+$ source venv/bin/activate
+(venv) $
+```
+
+2. Install the requirements
+
+```
+(venv) $ python -m pip install -r requirements.txt
+```
+
+## Run the Project
+
+```sh
+(venv) $ python -m rpchecker -u python.org
+The status of "python.org" is: "Online!" 👍
+```
+
+## Features
+
+RP Checker provides the following options:
+
+- `-u` or `--urls` takes one or more URLs and checks if they're online.
+- `-f` or `--input-file` takes a file containing a list of URLs to check.
+- `-a` or `--asynchronous` runs the check asynchronously.
+
+## About the Author
+
+Leodanis Pozo Ramos - Email: [email protected]
+
+## License
+
+Distributed under the MIT license. See `LICENSE` in the root directory of this `materials` repo for more information.

python-site-connectivity-checker/source_code_final/requirements.txt

@@ -0,0 +1 @@
+aiohttp==3.7.4.post0

python-site-connectivity-checker/source_code_final/rpchecker/__init__.py

@@ -0,0 +1,3 @@
+"""Top-level package rpchecker."""
+
+__version__ = "0.1.0"

python-site-connectivity-checker/source_code_final/rpchecker/__main__.py

@@ -0,0 +1,70 @@
+"""This module provides the RP Checker entry point script."""
+
+import asyncio
+import pathlib
+import sys
+
+from rpchecker.checker import site_is_online, site_is_online_async
+from rpchecker.cli import display_check_result, read_user_cli_args
+
+
+def main():
+    """Run RP Checker."""
+    user_args = read_user_cli_args()
+    urls = _get_websites_urls(user_args)
+    if not urls:
+        print("Error: no URLs to check", file=sys.stderr)
+        sys.exit(1)
+
+    if user_args.asynchronous:
+        asyncio.run(_asynchronous_check(urls))
+    else:
+        _synchronous_check(urls)
+
+
+def _get_websites_urls(user_args):
+    urls = user_args.urls
+    if user_args.input_file:
+        urls += _read_urls_from_file(user_args.input_file)
+    return urls
+
+
+def _read_urls_from_file(file):
+    file_path = pathlib.Path(file)
+    if file_path.is_file():
+        with file_path.open() as urls_file:
+            urls = [url.strip() for url in urls_file]
+            if urls:
+                return urls
+            print(f"Error: empty input file, {file}", file=sys.stderr)
+    else:
+        print("Error: input file not found", file=sys.stderr)
+    return []
+
+
+async def _asynchronous_check(urls):
+    async def _check(url):
+        error = ""
+        try:
+            result = await site_is_online_async(url)
+        except Exception as e:
+            result = False
+            error = str(e)
+        display_check_result(result, url, error)
+
+    await asyncio.gather(*(_check(url) for url in urls))
+
+
+def _synchronous_check(urls):
+    for url in urls:
+        error = ""
+        try:
+            result = site_is_online(url)
+        except Exception as e:
+            result = False
+            error = str(e)
+        display_check_result(result, url, error)
+
+
+if __name__ == "__main__":
+    main()

python-site-connectivity-checker/source_code_final/rpchecker/checker.py

@@ -0,0 +1,46 @@
+import asyncio
+from http.client import HTTPConnection
+from urllib.parse import urlparse
+
+import aiohttp
+
+
+def site_is_online(url, timeout=2):
+    """Return True if the target URL is online.
+
+    Raise an exception otherwise.
+    """
+    error = Exception("unknown error")
+    parser = urlparse(url)
+    host = parser.netloc or parser.path.split("/")[0]
+    for port in (80, 443):
+        connection = HTTPConnection(host=host, port=port, timeout=timeout)
+        try:
+            connection.request("HEAD", "/")
+            return True
+        except Exception as e:
+            error = e
+        finally:
+            connection.close()
+    raise error
+
+
+async def site_is_online_async(url, timeout=2):
+    """Return True if the target URL is online.
+
+    Raise an exception otherwise.
+    """
+    error = Exception("unknown error")
+    parser = urlparse(url)
+    host = parser.netloc or parser.path.split("/")[0]
+    for scheme in ("http", "https"):
+        target_url = scheme + "://" + host
+        async with aiohttp.ClientSession() as session:
+            try:
+                await session.head(target_url, timeout=timeout)
+                return True
+            except asyncio.exceptions.TimeoutError:
+                error = Exception("timed out")
+            except Exception as e:
+                error = e
+    raise error

python-site-connectivity-checker/source_code_final/rpchecker/cli.py

@@ -0,0 +1,43 @@
+"""This module provides the CLI for RP Checker."""
+
+import argparse
+
+
+def read_user_cli_args():
+    """Handle the CLI arguments and options"""
+    parser = argparse.ArgumentParser(
+        prog="rpchecker", description="check the availability of websites"
+    )
+    parser.add_argument(
+        "-u",
+        "--urls",
+        metavar="URLs",
+        nargs="+",
+        type=str,
+        default=[],
+        help="enter one or more website URLs",
+    )
+    parser.add_argument(
+        "-f",
+        "--input-file",
+        metavar="FILE",
+        type=str,
+        default="",
+        help="read URLs from a file",
+    )
+    parser.add_argument(
+        "-a",
+        "--asynchronous",
+        action="store_true",
+        help="run the connectivity check asynchronously",
+    )
+    return parser.parse_args()
+
+
+def display_check_result(result, url, error=""):
+    """Display the result of a connectivity check."""
+    print(f'The status of "{url}" is:', end=" ")
+    if result:
+        print('"Online!" 👍')
+    else:
+        print(f'"Offline?" 👎 \n  Error: "{error}"')

python-site-connectivity-checker/source_code_final/sample-urls.txt

@@ -0,0 +1,4 @@
+python.org
+pypi.org
+docs.python.org
+peps.python.org

python-site-connectivity-checker/source_code_step_1/README.md

@@ -0,0 +1,42 @@
+# Build a Site Connectivity Checker in Python
+
+RP Checker is a site connectivity checker utility. It takes one or more website URLs and checks if those sites are online. It can perform the connectivity checks either synchronously or asynchronously.
+
+## Installation
+
+1. Create a Python virtual environment
+
+```sh
+$ python -m venv ./venv
+$ source venv/bin/activate
+(venv) $
+```
+
+2. Install the requirements
+
+```
+(venv) $ python -m pip install -r requirements.txt
+```
+
+## Run the Project
+
+```sh
+(venv) $ python -m rpchecker -u python.org
+The status of "python.org" is: "Online!" 👍
+```
+
+## Features
+
+RP Checker provides the following options:
+
+- `-u` or `--urls` takes one or more URLs and checks if they're online.
+- `-f` or `--input-file` takes a file containing a list of URLs to check.
+- `-a` or `--asynchronous` runs the check asynchronously.
+
+## About the Author
+
+Leodanis Pozo Ramos - Email: [email protected]
+
+## License
+
+Distributed under the MIT license. See `LICENSE` in the root directory of this `materials` repo for more information.