Markdown-Checker 0.0.5__py3-none-any.whl

markdown_checker/get_input_args/get_input_args.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python3
+"""
+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. 
+    Command Line Arguments:
+      1. Tutorials Path as --dir
+      2. Function to be executed as --func
+    This function returns these arguments as an ArgumentParser object.
+    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 using ArgumentParser
+    parser = argparse.ArgumentParser()
+
+    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'])
+
+    return parser.parse_args()

markdown_checker/markdown_checker.py

@@ -0,0 +1,190 @@
+#!/usr/bin/env python3
+"""
+Module providing automatic checks functionality to markdown files 
+following some Guidelines
+"""
+import os
+import re
+
+# Helper Functions
+
+def get_lessons_paths(root_path: str) -> dict:
+    """function to compile a dictionary of directories
+    
+    Keyword arguments:
+    root_path -- directory to go through looking for md files
+    Return: formatted dictionary with directories as key and an array of files as values
+    """
+    lessons = {}
+    # add root path to the dictionary
+    lessons[root_path] = []
+    pass_list = ['CODE_OF_CONDUCT.md', 'CONTRIBUTING.md', 'SECURITY.md']
+    # get lessons folders
+    for item in os.listdir(root_path):
+        if os.path.isdir(os.path.join(root_path, item)):
+            lessons[item] = []
+
+    # get lesson exercises (md, ipynb files)
+    for lesson, _ in lessons.items():
+        if lesson != root_path:
+            for item in os.listdir(os.path.join(root_path, lesson)):
+                # check for translations directories
+                if os.path.isdir(os.path.join(root_path, lesson, item)):
+                    for sub_item in os.listdir(os.path.join(root_path, lesson, item)):
+                        if os.path.isdir(os.path.join(root_path, lesson, item, sub_item)):
+                            for sub_item2 in os.listdir(os.path.join(root_path, lesson, item, sub_item)):
+                                # check for .md and .ipynb files and store them
+                                if sub_item2.lower().endswith(('.md', '.ipynb')) and sub_item2 not in pass_list:
+                                    lessons[lesson].append(os.path.join(item, sub_item, sub_item2))
+                        # check for .md and .ipynb files and store them
+                        elif sub_item.lower().endswith(('.md', '.ipynb')) and sub_item not in pass_list:
+                            lessons[lesson].append(os.path.join(item, sub_item))
+                # check for .md and .ipynb files and store them
+                elif item.lower().endswith(('.md', '.ipynb')) and item not in pass_list:
+                    lessons[lesson].append(item)
+    # get .md and .ipynb in root directory
+    for item in os.listdir(root_path):
+        if item.lower().endswith(('.md', '.ipynb')) and item not in pass_list:
+            lessons[root_path].append(item)
+
+    # check to remove folders that don't have .md files in them
+    lessons = {key: values for key, values in lessons.items() if len(values) > 0}
+
+    return lessons
+
+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
+    check_type -- broken or tracking or locale
+    Return: broken links and associated file path
+    """
+    all_links = get_links_from_file(file_path)
+
+    # check if file has links
+    if len(all_links) > 0:
+        formatted_output = f"    FILE '{file_path}'\n"
+        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'    has the following broken relative paths {broken_path}\n'
+                    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'    has the following paths with no tracking id {tracking_id_paths}\n'
+                    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'    has the following links with no tracking id {tracking_id_urls}\n'
+                    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'    has the following links with country locale {country_locale_urls}\n'
+                    return formatted_output
+
+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:
+        data = file.read()
+        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']
+    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]+)')
+
+    for link in all_links:
+        link = link.split(" ")[0]
+        matches = re.findall(path_pattern, link)
+        if matches:
+            paths.append(link)
+    return paths
+
+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))):
+            broken_path.append(path)
+    return broken_path
+
+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}\/')
+        matches = re.findall(locale_pattern, url)
+        if matches:
+            country_locale.append(url)
+    return country_locale
+
+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=')
+        matches = re.findall(tracking_pattern, url)
+        if not matches:
+            tracking_id.append(url)
+    return tracking_id
+
+# 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:
+        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@:%_\+.~#?&\/\/=]*)')
+        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:
+        data = file.read()
+        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())
+    return paths

markdown_checker/validate_markdown.py

@@ -0,0 +1,45 @@
+#!/usr/bin/env python3
+"""
+Module providing automatic checks functionality to markdown files 
+following some Guidelines
+"""
+import os
+from markdown_checker.get_input_args.get_input_args import get_input_args
+from markdown_checker.markdown_checker import get_lessons_paths, check_broken_links
+
+def main() -> None:
+    """Main program get inputs and run checks"""
+
+    # get input arguments directory, function to run
+    in_arg = get_input_args()
+
+    lessons = get_lessons_paths(in_arg.dir)
+
+    # iterate over the files to validate the content
+    for lesson_folder_name, lessons_array in lessons.items():
+        for lesson_file_name in lessons_array:
+            file_path = os.path.join(
+                in_arg.dir,
+                lesson_folder_name,
+                lesson_file_name)
+            if in_arg.dir == lesson_folder_name:
+                file_path = os.path.join(lesson_folder_name, lesson_file_name)
+            if "check_broken_paths" in in_arg.func:
+                formatted_output = check_broken_links(file_path, "path" , "broken")
+                if formatted_output:
+                    print(formatted_output)
+            if "check_paths_tracking" in in_arg.func:
+                formatted_output = check_broken_links(file_path, "path" , "tracking")
+                if formatted_output:
+                    print(formatted_output)
+            if "check_urls_tracking" in in_arg.func:
+                formatted_output = check_broken_links(file_path, "url" , "tracking")
+                if formatted_output:
+                    print(formatted_output)
+            if "check_urls_locale" in in_arg.func:
+                formatted_output = check_broken_links(file_path, "url" , "locale")
+                if formatted_output:
+                    print(formatted_output)
+
+if __name__ == "__main__":
+    main()

markdown_checker-0.0.5.dist-info/LICENSE

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

markdown_checker-0.0.5.dist-info/METADATA

@@ -0,0 +1,38 @@
+Metadata-Version: 2.1
+Name: markdown-checker
+Version: 0.0.5
+Summary: A markdown validation reporting tool
+Home-page: https://github.com/john0isaac/markdown-checker
+Author: John Aziz
+Author-email: johnaziz269@gmail.com
+Maintainer: John Aziz
+Maintainer-email: johnaziz269@gmail.com
+License: MIT
+Project-URL: Bug Tracker, https://github.com/john0isaac/markdown-checker/issues
+Project-URL: Contributing, https://github.com/john0isaac/markdown-checker/pulls
+Project-URL: Source Code, https://github.com/john0isaac/markdown-checker
+Project-URL: Releases, https://github.com/john0isaac/markdown-checker/releases
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+[![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}`. Replace `{src}` with the directory you want to analyse and {func} with the available functions like check_broken_paths.
+3. The output will be displayed in the terminal.
+
+# 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/action-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.5.dist-info/RECORD

@@ -0,0 +1,11 @@
+markdown_checker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markdown_checker/markdown_checker.py,sha256=p1uop6XCz7GFWXAcrt6zXU0Aqzw064MHG6u3AQ3T0FU,8200
+markdown_checker/validate_markdown.py,sha256=gqWYRKpWX3isDklZHUA0Ntv8zcQZ-1jsEguM71G4Gmk,1829
+markdown_checker/get_input_args/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+markdown_checker/get_input_args/get_input_args.py,sha256=0zmcGA7oL_X7rHoMS1TGhJ1m4twhFANLrgpR8WY_kJI,1514
+markdown_checker-0.0.5.dist-info/LICENSE,sha256=2OT8T4F_Pws8nPXRQMIZ4QsqZeJxYaXlT6sA8QcCcWI,1066
+markdown_checker-0.0.5.dist-info/METADATA,sha256=Ex5PnyCydSBp8zj3zYMWuoxkpzmHQo65uUQKgW-JHsw,2057
+markdown_checker-0.0.5.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+markdown_checker-0.0.5.dist-info/entry_points.txt,sha256=8GhZYw0KWydvLfV0A0Mh6k_20wSxbNEdTk6B5ZEopMc,77
+markdown_checker-0.0.5.dist-info/top_level.txt,sha256=QtyQyZKRVTb_xtywJLGaNZkeDwo5UqQ_O1c2yjlPxjY,17
+markdown_checker-0.0.5.dist-info/RECORD,,

markdown_checker-0.0.5.dist-info/WHEEL

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

markdown_checker-0.0.5.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+markdown-checker = markdown_checker.validate_markdown:main

markdown_checker-0.0.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+markdown_checker