Markdown-Checker 0.0.9__tar.gz → 0.1.1__tar.gz

{markdown-checker-0.0.9/markdown_checker.egg-info → markdown-checker-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.0.9
+Version: 0.1.1
 Summary: A markdown validation reporting tool
 Home-page: https://github.com/john0isaac/markdown-checker
 Author: John Aziz
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
 
 [![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
 [![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)
@@ -38,3 +39,50 @@ markdown-checker is a markdown validation reporting tool.
 # Using markdown-checker in GitHub Actions
 
 The tool has been designed to be run within a GitHub workflow using the [action-check-markdown](https://github.com/marketplace/actions/check-markdown) GitHub action. The action will automatically post the output of the tool to your GitHub pull request as a comment.
+
+# Supported Functions
+
+## Check broken relative paths
+This function ensures that any relative path in your files is working.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_broken_paths -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check broken URLs
+This function ensures that any web URL in your files is working and returning 200 status code.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_broken_urls -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check country locale present in URLs
+This function ensures that any relative path in your files is working. 
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check Contributor ID missing from paths
+This function ensures that any relative path has tracking in it.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_paths_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check Contributor ID missing from URLs
+This function ensures that any URL has tracking in it.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```

markdown-checker-0.1.1/README.md

@@ -0,0 +1,64 @@
+[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
+[![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)
+
+[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/john0isaac/markdown-checker/issues)
+[![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://github.com/john0isaac/markdown-checker/pulls)
+
+markdown-checker is a markdown validation reporting tool.
+
+# How To
+
+1. Run `pip install markdown-checker`.
+2. Run `markdown-checker -d {src} -f {func} -gu {url}`. Replace `{src}` with the directory you want to analyze, {func} with the available functions like check_broken_paths, {gu} with your contribution guidance full URL.
+3. The output will be displayed in the terminal and in a `comments.md` file.
+
+# Using markdown-checker in GitHub Actions
+
+The tool has been designed to be run within a GitHub workflow using the [action-check-markdown](https://github.com/marketplace/actions/check-markdown) GitHub action. The action will automatically post the output of the tool to your GitHub pull request as a comment.
+
+# Supported Functions
+
+## Check broken relative paths
+This function ensures that any relative path in your files is working.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_broken_paths -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check broken URLs
+This function ensures that any web URL in your files is working and returning 200 status code.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_broken_urls -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check country locale present in URLs
+This function ensures that any relative path in your files is working. 
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check Contributor ID missing from paths
+This function ensures that any relative path has tracking in it.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_paths_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check Contributor ID missing from URLs
+This function ensures that any URL has tracking in it.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker/check_markdown.py

@@ -1,20 +1,22 @@
 """
-Module providing automatic checks functionality to markdown files 
+Module providing automatic checks functionality to markdown files
 following some Guidelines
 """
+
 from markdown_checker.links.link_operations import (
+    check_paths_exists,
+    check_url_alive,
+    check_url_locale,
+    check_url_tracking,
     get_links_from_file,
     get_paths_from_links,
     get_urls_from_links,
-    check_paths_exists,
-    check_url_locale,
-    check_url_tracking
 )
 
 
-def check_broken_links(file_path : str, link_type : str , check_type: str) -> str:
+def check_broken_links(file_path: str, link_type: str, check_type: str) -> str:
     """function that checks if urls and hyperlinks are broken
-    
+
     Keyword arguments:
     file_path -- a path to text file to check
     link_type -- path or url
@@ -25,28 +27,55 @@ def check_broken_links(file_path : str, link_type : str , check_type: str) -> st
 
     # check if file has links
     if len(all_links) > 0:
-        formatted_output = f"|<code>{file_path}</code>|"
+        formatted_output = f"| `{file_path}` |"
         if link_type == "path":
             paths = get_paths_from_links(all_links)
             if check_type == "broken" and len(paths) > 0:
                 broken_path = check_paths_exists(file_path, paths)
-                if len (broken_path) > 0:
-                    formatted_output += f'<code>{broken_path}</code>|\n'
+                if len(broken_path) > 0:
+                    formatted_output += format_links(broken_path)
                     return formatted_output
             elif check_type == "tracking" and len(paths) > 0:
                 tracking_id_paths = check_url_tracking(paths)
                 if len(tracking_id_paths) > 0:
-                    formatted_output += f'<code>{tracking_id_paths}</code>|\n'
+                    formatted_output += format_links(tracking_id_paths)
                     return formatted_output
         elif link_type == "url":
             urls = get_urls_from_links(all_links)
             if check_type == "tracking" and len(urls) > 0:
                 tracking_id_urls = check_url_tracking(urls)
                 if len(tracking_id_urls) > 0:
-                    formatted_output += f'<code>{tracking_id_urls}</code>|\n'
+                    formatted_output += format_links(tracking_id_urls)
                     return formatted_output
             elif check_type == "locale" and len(urls) > 0:
                 country_locale_urls = check_url_locale(urls)
                 if len(country_locale_urls) > 0:
-                    formatted_output += f'<code>{country_locale_urls}</code>|\n'
+                    formatted_output += format_links(country_locale_urls)
+                    return formatted_output
+            elif check_type == "broken" and len(urls) > 0:
+                dead_urls = check_url_alive(urls)
+                if len(dead_urls) > 0:
+                    formatted_output += format_links(dead_urls)
                     return formatted_output
+
+
+def format_links(links: list) -> str:
+    """
+    Formats a list of links into a string with numbered bullets.
+
+    Args:
+        links (list): A list of links.
+
+    Returns:
+        str: The formatted string with numbered bullets.
+    """
+    formatted_links = ""
+    i = 1
+    for link in links:
+        if i == len(links):
+            formatted_links += f" {i}. `{link}` |\n"
+        else:
+            formatted_links += f" {i}. `{link}` <br/>"
+        i += 1
+
+    return formatted_links

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker/generators/md_generator.py

@@ -3,6 +3,11 @@ CHECK_BROKEN_PATHS = """# Check Broken Paths
 We have automatically detected the following broken relative paths in your lessons. Review and fix the paths to resolve this issue.
 
 Check the file paths and associated broken paths inside them."""
+CHECK_BROKEN_URLS = """# Check Broken URLS
+
+We have automatically detected the following broken URLS in your lessons. Review and fix the paths to resolve this issue.
+
+Check the file paths and associated broken urls inside them."""
 CHECK_PATHS_TRACKING = """# Check Missing Tracking from Paths
 
 We have automatically detected missing tracking id from the following relative paths in your lessons. Review and add tracking to paths to resolve this issue.
@@ -19,12 +24,16 @@ We have automatically detected added country locale to URLs in your lessons. Rev
 
 Check the file paths and associated URLs inside them."""
 
+
 def write_md_file(generated_md: str) -> None:
     """Write the formatted output to a markdown file"""
     with open("comment.md", "w", encoding="utf-8") as file:
         file.write(generated_md)
 
-def generate_md(formatted_output: str, function_name: str, contributing_guide_url: str) -> None:
+
+def generate_md(
+    formatted_output: str, function_name: str, contributing_guide_url: str
+) -> None:
     """Generate markdown file based on the formatted output, function name, and contributing guide URL.
 
     Args:
@@ -38,13 +47,25 @@ def generate_md(formatted_output: str, function_name: str, contributing_guide_ur
     """
     contributing_guide_line = f" For more details, check our [Contributing Guide]({contributing_guide_url}).\n\n"
     if function_name == "check_broken_paths":
-        formatted_output = CHECK_BROKEN_PATHS + contributing_guide_line + formatted_output
+        formatted_output = (
+            CHECK_BROKEN_PATHS + contributing_guide_line + formatted_output
+        )
+    elif function_name == "check_broken_urls":
+        formatted_output = (
+            CHECK_BROKEN_URLS + contributing_guide_line + formatted_output
+        )
     elif function_name == "check_paths_tracking":
-        formatted_output = CHECK_PATHS_TRACKING + contributing_guide_line + formatted_output
+        formatted_output = (
+            CHECK_PATHS_TRACKING + contributing_guide_line + formatted_output
+        )
     elif function_name == "check_urls_tracking":
-        formatted_output = CHECK_URLS_TRACKING + contributing_guide_line + formatted_output
+        formatted_output = (
+            CHECK_URLS_TRACKING + contributing_guide_line + formatted_output
+        )
     elif function_name == "check_urls_locale":
-        formatted_output = CHECK_URLS_LOCALE + contributing_guide_line + formatted_output
+        formatted_output = (
+            CHECK_URLS_LOCALE + contributing_guide_line + formatted_output
+        )
     else:
         raise ValueError("Invalid function name")
 

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker/inputs/input_arguments.py

@@ -1,16 +1,18 @@
 """
-Module providing automatic checks functionality to markdown files 
+Module providing automatic checks functionality to markdown files
 following some Guidelines
 """
+
 import argparse
 
+
 def get_input_args() -> None:
     """
     Retrieves and parses the 2 command line arguments provided by the user when
-    they run the program from a terminal window. This function uses Python's 
-    argparse module to created and defined these 2 command line arguments. If 
-    the user fails to provide some or all of the 2 arguments, then the default 
-    values are used for the missing arguments. 
+    they run the program from a terminal window. This function uses Python's
+    argparse module to created and defined these 2 command line arguments. If
+    the user fails to provide some or all of the 2 arguments, then the default
+    values are used for the missing arguments.
     Command Line Arguments:
       1. Tutorials Path as --dir
       2. Function to be executed as --func
@@ -18,22 +20,42 @@ def get_input_args() -> None:
     Parameters:
      None - simply using argparse module to create & store command line arguments
     Returns:
-     parse_args() -data structure that stores the command line arguments object  
+     parse_args() -data structure that stores the command line arguments object
     """
     # Parse using ArgumentParser
     parser = argparse.ArgumentParser()
 
-    parser.add_argument('-d', '--dir', type = str, default = './',
-                    help = 'path to the root directory', required=True)
+    parser.add_argument(
+        "-d",
+        "--dir",
+        type=str,
+        default="./",
+        help="path to the root directory",
+        required=True,
+    )
 
-    parser.add_argument('-f', '--func', type = str, required = True,
-                        help = 'function to be executed',
-                        choices=['check_broken_paths',
-                                 'check_paths_tracking',
-                                 'check_urls_tracking',
-                                 'check_urls_locale'])
+    parser.add_argument(
+        "-f",
+        "--func",
+        type=str,
+        required=True,
+        help="function to be executed",
+        choices=[
+            "check_broken_paths",
+            "check_broken_urls",
+            "check_paths_tracking",
+            "check_urls_tracking",
+            "check_urls_locale",
+        ],
+    )
 
-    parser.add_argument('-gu', '--guide-url', type = str, default = 'https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md',
-                    help = 'full url of your contributing guide', required=True)
+    parser.add_argument(
+        "-gu",
+        "--guide-url",
+        type=str,
+        default="https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
+        help="full url of your contributing guide",
+        required=True,
+    )
 
     return parser.parse_args()

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker/links/link_operations.py

@@ -1,38 +1,49 @@
-import re
 import os
+import re
+
 
 def get_links_from_file(file_path: str) -> list:
     """function to get an array of markdown links from a file
     flags markdown links captures the part inside () that comes right after []
     """
     all_links = []
-    with open(file_path, 'r',  encoding="utf-8") as file:
+    with open(file_path, "r", encoding="utf-8") as file:
         data = file.read()
-        link_pattern = re.compile(r'\]\((.*?)\)| \)')
+        link_pattern = re.compile(r"\]\((.*?)\)| \)")
         matches = re.finditer(link_pattern, data)
         for matched_group in matches:
             if matched_group.group(1):
                 all_links.append(matched_group.group(1))
     return all_links
 
+
 def get_urls_from_links(all_links: list) -> list:
     """function to get an array of urls from a list"""
     urls = []
-    url_pattern = re.compile(r'https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9]{1,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)')
-    allowed_list = ['github.com', 'microsoft.com', 'visualstudio.com', 'aka.ms', 'azure.com']
+    url_pattern = re.compile(
+        r"https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9]{1,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)"
+    )
+    allowed_list = [
+        "github.com",
+        "microsoft.com",
+        "visualstudio.com",
+        "aka.ms",
+        "azure.com",
+    ]
     for link in all_links:
         matches = re.findall(url_pattern, link)
-        
+
         if matches and any(allowed in link.lower() for allowed in allowed_list):
             urls.append(link)
     return urls
 
+
 def get_paths_from_links(all_links: list) -> list:
     """function to get relative paths from a list
     flags paths that start with ./ or ../
     """
     paths = []
-    path_pattern = re.compile(r'(\.{1,2}\/)+([A-Za-z0-9-]+\/)*(.+\.[A-Za-z]+)')
+    path_pattern = re.compile(r"(\.{1,2}\/)+([A-Za-z0-9-]+\/)*(.+\.[A-Za-z]+)")
 
     for link in all_links:
         link = link.split(" ")[0]
@@ -41,59 +52,90 @@ def get_paths_from_links(all_links: list) -> list:
             paths.append(link)
     return paths
 
-def check_paths_exists(file_path : str, paths : list) -> list:
+
+def check_paths_exists(file_path: str, paths: list) -> list:
     """function checks if a path exist if not return non existent paths
     flags any relative path that can't be accessed
     """
     broken_path = []
     for path in paths:
-        path = re.sub(r'(\?|\&)(WT|wt)\.mc_id=.*', '', path)
-        if not os.path.exists(os.path.normpath(os.path.join(os.path.dirname(file_path), path))):
+        path = re.sub(r"(\?|\&)(WT|wt)\.mc_id=.*", "", path)
+        if not os.path.exists(
+            os.path.normpath(os.path.join(os.path.dirname(file_path), path))
+        ):
             broken_path.append(path)
     return broken_path
 
-def check_url_locale(urls : list) -> list:
+
+def check_url_locale(urls: list) -> list:
     """function checks if a url has country locale
     flags urls that have ==> /en-us/
     """
     country_locale = []
     for url in urls:
-        locale_pattern = re.compile(r'\/[a-z]{2}-[a-z]{2}\/')
+        if (
+            "video-embed.html" in url
+            or "https://www.microsoft.com/en-us/security/blog" in url
+        ):
+            continue
+        locale_pattern = re.compile(r"\/[a-z]{2}-[a-z]{2}\/")
         matches = re.findall(locale_pattern, url)
-        if matches and "video-embed.html" not in url:
+        if matches:
             country_locale.append(url)
     return country_locale
 
-def check_url_tracking(urls : list) -> list:
+
+def check_url_tracking(urls: list) -> list:
     """function checks if a url has tracking id
     flags urls missing ==> (? or &) plus WT.mc_id= or wt.mc_id=
     """
     tracking_id = []
     for url in urls:
-        tracking_pattern = re.compile(r'(\?|\&)(WT|wt)\.mc_id=')
+        tracking_pattern = re.compile(r"(\?|\&)(WT|wt)\.mc_id=")
         matches = re.findall(tracking_pattern, url)
         if not matches:
             tracking_id.append(url)
     return tracking_id
 
+
+def check_url_alive(urls: list) -> list:
+    import requests
+
+    broken_urls = []
+    for url in urls:
+        try:
+            response = requests.get(url, timeout=10)
+            if response.status_code != 200:
+                broken_urls.append(url)
+        except requests.exceptions.RequestException:
+            broken_urls.append(url)
+            continue
+    return broken_urls
+
+
 # DEPRECATED
 def get_urls_from_file(file_path: str) -> list:
     """function to get an array of urls from a file"""
     urls = []
-    with open(file_path, 'r',  encoding="utf-8") as file:
+    with open(file_path, "r", encoding="utf-8") as file:
         data = file.read()
-        url_pattern = re.compile(r'https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9]{1,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)')
+        url_pattern = re.compile(
+            r"https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-zA-Z0-9]{1,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)"
+        )
         matches = re.finditer(url_pattern, data)
         for matched_group in matches:
             urls.append(matched_group.group())
     return urls
 
+
 def get_paths_from_file(file_path: str) -> list:
     """function to get relative paths from a file"""
     paths = []
-    with open(file_path, 'r',  encoding="utf-8") as file:
+    with open(file_path, "r", encoding="utf-8") as file:
         data = file.read()
-        path_pattern = re.compile(r'(\.{1,2}\/)+([A-Za-z0-9-]+\/)*([A-Za-z0-9]+\.[A-Za-z]+)')
+        path_pattern = re.compile(
+            r"(\.{1,2}\/)+([A-Za-z0-9-]+\/)*([A-Za-z0-9]+\.[A-Za-z]+)"
+        )
         matches = re.finditer(path_pattern, data)
         for matched_group in matches:
             paths.append(matched_group.group())

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker/paths/files_paths_reader.py

@@ -10,6 +10,7 @@ Functions:
 
 import os
 
+
 def get_files_paths_list(root_path: str, extensions: list = None) -> list:
     """
     function returns a list of files in a directory and its subdirectories,

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker/validate_markdown.py

@@ -1,12 +1,14 @@
 #!/usr/bin/env python3
 """
-Module providing automatic checks functionality to markdown files 
+Module providing automatic checks functionality to markdown files
 following some Guidelines
 """
-from markdown_checker.inputs.input_arguments import get_input_args
+
 from markdown_checker.check_markdown import check_broken_links
-from markdown_checker.paths.files_paths_reader import get_files_paths_list
 from markdown_checker.generators.md_generator import generate_md
+from markdown_checker.inputs.input_arguments import get_input_args
+from markdown_checker.paths.files_paths_reader import get_files_paths_list
+
 
 def main() -> None:
     """Main program get inputs and run checks"""
@@ -16,7 +18,14 @@ def main() -> None:
 
     _, files_paths = get_files_paths_list(in_arg.dir)
 
-    pass_list = ['./CODE_OF_CONDUCT.md', './CONTRIBUTING.md', './SECURITY.md', '.\CODE_OF_CONDUCT.md', '.\CONTRIBUTING.md', '.\SECURITY.md']
+    pass_list = [
+        "./CODE_OF_CONDUCT.md",
+        "./CONTRIBUTING.md",
+        "./SECURITY.md",
+        ".\CODE_OF_CONDUCT.md",
+        ".\CONTRIBUTING.md",
+        ".\SECURITY.md",
+    ]
     files_paths = [file_path for file_path in files_paths if file_path not in pass_list]
 
     formatted_output = ""
@@ -24,25 +33,32 @@ def main() -> None:
     # iterate over the files to validate the content
     for file_path in files_paths:
         if "check_broken_paths" in in_arg.func:
-            broken_paths = check_broken_links(file_path, "path" , "broken")
+            broken_paths = check_broken_links(file_path, "path", "broken")
             if broken_paths:
                 formatted_output += broken_paths
         if "check_paths_tracking" in in_arg.func:
-            paths_tracking = check_broken_links(file_path, "path" , "tracking")
+            paths_tracking = check_broken_links(file_path, "path", "tracking")
             if paths_tracking:
                 formatted_output += paths_tracking
         if "check_urls_tracking" in in_arg.func:
-            urls_tracking = check_broken_links(file_path, "url" , "tracking")
+            urls_tracking = check_broken_links(file_path, "url", "tracking")
             if urls_tracking:
                 formatted_output += urls_tracking
         if "check_urls_locale" in in_arg.func:
-            urls_locale = check_broken_links(file_path, "url" , "locale")
+            urls_locale = check_broken_links(file_path, "url", "locale")
             if urls_locale:
                 formatted_output += urls_locale
+        if "check_broken_urls" in in_arg.func:
+            broken_urls = check_broken_links(file_path, "url", "broken")
+            if broken_urls:
+                formatted_output += broken_urls
     if formatted_output != "":
-        formatted_output = "| File Full Path | Issues |\n|--------|--------|\n" + formatted_output
+        formatted_output = (
+            "| File Full Path | Issues |\n|--------|--------|\n" + formatted_output
+        )
         print(formatted_output)
         generate_md(formatted_output, in_arg.func, in_arg.guide_url)
 
+
 if __name__ == "__main__":
     main()

{markdown-checker-0.0.9 → markdown-checker-0.1.1/markdown_checker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.0.9
+Version: 0.1.1
 Summary: A markdown validation reporting tool
 Home-page: https://github.com/john0isaac/markdown-checker
 Author: John Aziz
@@ -20,6 +20,7 @@ Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests
 
 [![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
 [![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)
@@ -38,3 +39,50 @@ markdown-checker is a markdown validation reporting tool.
 # Using markdown-checker in GitHub Actions
 
 The tool has been designed to be run within a GitHub workflow using the [action-check-markdown](https://github.com/marketplace/actions/check-markdown) GitHub action. The action will automatically post the output of the tool to your GitHub pull request as a comment.
+
+# Supported Functions
+
+## Check broken relative paths
+This function ensures that any relative path in your files is working.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_broken_paths -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check broken URLs
+This function ensures that any web URL in your files is working and returning 200 status code.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_broken_urls -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check country locale present in URLs
+This function ensures that any relative path in your files is working. 
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check Contributor ID missing from paths
+This function ensures that any relative path has tracking in it.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_paths_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## Check Contributor ID missing from URLs
+This function ensures that any URL has tracking in it.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/markdown_checker.egg-info/SOURCES.txt

@@ -11,6 +11,7 @@ markdown_checker.egg-info/PKG-INFO
 markdown_checker.egg-info/SOURCES.txt
 markdown_checker.egg-info/dependency_links.txt
 markdown_checker.egg-info/entry_points.txt
+markdown_checker.egg-info/requires.txt
 markdown_checker.egg-info/top_level.txt
 markdown_checker/generators/__init__.py
 markdown_checker/generators/md_generator.py

markdown-checker-0.1.1/markdown_checker.egg-info/requires.txt

@@ -0,0 +1 @@
+requests

{markdown-checker-0.0.9 → markdown-checker-0.1.1}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = markdown-checker
-version = 0.0.9
+version = 0.1.1
 author = John Aziz
 author_email = johnaziz269@gmail.com
 maintainer = John Aziz
@@ -24,6 +24,8 @@ classifiers =
 	Programming Language :: Python :: 3.8
 
 [options]
+install_requires = 
+	requests
 include_package_data = True
 packages = find:
 python_requires = >=3.8

markdown-checker-0.1.1/tests/test_markdown_checker.py

@@ -0,0 +1,127 @@
+"""
+Module to check paths in markdown files.
+"""
+
+import subprocess
+
+
+def check_broken_paths():
+    """
+    Function to check for broken paths.
+    """
+    print("check_broken_paths was called")
+    subprocess.run(
+        [
+            "markdown-checker",
+            "-d",
+            "./tests/resources/",
+            "-f",
+            "check_broken_paths",
+            "-gu",
+            "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
+        ],
+        check=False,
+    )
+
+
+def check_broken_urls():
+    """
+    Function to check for broken paths.
+    """
+    print("check_broken_urls was called")
+    subprocess.run(
+        [
+            "markdown-checker",
+            "-d",
+            "./tests/resources/",
+            "-f",
+            "check_broken_urls",
+            "-gu",
+            "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
+        ],
+        check=False,
+    )
+
+
+def check_paths_tracking():
+    """
+    Function to check paths tracking.
+    """
+    print("check_paths_tracking was called")
+    subprocess.run(
+        [
+            "markdown-checker",
+            "-d",
+            "./tests/resources/",
+            "-f",
+            "check_paths_tracking",
+            "-gu",
+            "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
+        ],
+        check=False,
+    )
+
+
+def check_urls_tracking():
+    """
+    Function to check URLs tracking.
+    """
+    print("check_urls_tracking was called")
+    subprocess.run(
+        [
+            "markdown-checker",
+            "-d",
+            "./tests/resources/",
+            "-f",
+            "check_urls_tracking",
+            "-gu",
+            "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
+        ],
+        check=False,
+    )
+
+
+def check_urls_locale():
+    """
+    Function to check URLs locale.
+    """
+    print("check_urls_locale was called")
+    subprocess.run(
+        [
+            "markdown-checker",
+            "-d",
+            "./tests/resources/",
+            "-f",
+            "check_urls_locale",
+            "-gu",
+            "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
+        ],
+        check=False,
+    )
+
+
+mydict = {
+    1: check_broken_paths,
+    2: check_broken_urls,
+    3: check_paths_tracking,
+    4: check_urls_tracking,
+    5: check_urls_locale,
+}
+
+try:
+    choices = list(
+        map(
+            int,
+            input(
+                "Do you want to: \n(1) Run check_broken_paths \n(2) Run check_broken_urls \n(3) Run check_paths_tracking \n(4) Run check_urls_tracking \n(5) Run check_urls_locale \n"
+            ).split(),
+        )
+    )
+except ValueError:
+    print("Please input number")
+
+for choice in choices:
+    if 0 < choice and choice < 6:
+        mydict[choice]()
+    else:
+        print("That is not between 1 and 5! Try again:")

markdown-checker-0.0.9/README.md

@@ -1,17 +0,0 @@
-[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
-[![Downloads](https://img.shields.io/pypi/dm/markdown-checker)](https://pypi.org/project/markdown-checker/)
-
-[![GitHub issues](https://img.shields.io/badge/issue_tracking-github-blue.svg)](https://github.com/john0isaac/markdown-checker/issues)
-[![Contributing](https://img.shields.io/badge/PR-Welcome-%23FF8300.svg?)](https://github.com/john0isaac/markdown-checker/pulls)
-
-markdown-checker is a markdown validation reporting tool.
-
-# How To
-
-1. Run `pip install markdown-checker`.
-2. Run `markdown-checker -d {src} -f {func} -gu {url}`. Replace `{src}` with the directory you want to analyze, {func} with the available functions like check_broken_paths, {gu} with your contribution guidance full URL.
-3. The output will be displayed in the terminal and in a `comments.md` file.
-
-# Using markdown-checker in GitHub Actions
-
-The tool has been designed to be run within a GitHub workflow using the [action-check-markdown](https://github.com/marketplace/actions/check-markdown) GitHub action. The action will automatically post the output of the tool to your GitHub pull request as a comment.

markdown-checker-0.0.9/tests/test_markdown_checker.py

@@ -1,46 +0,0 @@
-"""
-Module to check paths in markdown files.
-"""
-
-import subprocess
-
-def check_broken_paths():
-    """
-    Function to check for broken paths.
-    """
-    print("check_broken_paths was called")
-    subprocess.run(["markdown-checker", "-d", "./tests/resources/", "-f", "check_broken_paths", "-gu", "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md"], check=False)
-
-def check_paths_tracking():
-    """
-    Function to check paths tracking.
-    """
-    print("check_paths_tracking was called")
-    subprocess.run(["markdown-checker", "-d", "./tests/resources/", "-f", "check_paths_tracking", "-gu", "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md"], check=False)
-
-def check_urls_tracking():
-    """
-    Function to check URLs tracking.
-    """
-    print("check_urls_tracking was called")
-    subprocess.run(["markdown-checker", "-d", "./tests/resources/", "-f", "check_urls_tracking", "-gu", "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md"], check=False)
-
-def check_urls_locale():
-    """
-    Function to check URLs locale.
-    """
-    print("check_urls_locale was called")
-    subprocess.run(["markdown-checker", "-d", "./tests/resources/", "-f", "check_urls_locale", "-gu", "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md"], check=False)
-
-mydict = {1:check_broken_paths, 2:check_paths_tracking, 3:check_urls_tracking, 4:check_urls_locale}
-
-try:
-    choices = list(map(int,input("Do you want to: \n(1) Run check_broken_paths \n(2) Run check_paths_tracking \n(3) Run check_urls_tracking \n(4) Run check_urls_locale \n").split()))
-except ValueError:
-    print("Please input number")
-
-for choice in choices:
-    if 0 < choice and choice < 5:
-        mydict[choice]()
-    else:
-        print("That is not between 1 and 4! Try again:")