Markdown-Checker 0.0.5__tar.gz → 0.0.7__tar.gz

markdown-checker-0.0.7/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include markdown_checker/inputs/*
+include markdown_checker/paths/*
+include setup.cfg

{markdown-checker-0.0.5/markdown_checker.egg-info → markdown-checker-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.0.5
+Version: 0.0.7
 Summary: A markdown validation reporting tool
 Home-page: https://github.com/john0isaac/markdown-checker
 Author: John Aziz
@@ -35,4 +35,4 @@ markdown-checker is a markdown validation reporting tool.
 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.
+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.5 → markdown-checker-0.0.7}/README.md

@@ -12,4 +12,4 @@ markdown-checker is a markdown validation reporting tool.
 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.
+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.5/markdown_checker/get_input_args/get_input_args.py → markdown-checker-0.0.7/markdown_checker/inputs/input_arguments.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 """
 Module providing automatic checks functionality to markdown files 
 following some Guidelines

{markdown-checker-0.0.5 → markdown-checker-0.0.7}/markdown_checker/markdown_checker.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python3
 """
 Module providing automatic checks functionality to markdown files 
 following some Guidelines
@@ -8,50 +7,6 @@ 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
     
@@ -65,30 +20,30 @@ 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"    FILE '{file_path}'\n"
+        formatted_output = f"|<code>{file_path}</code>|"
         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'
+                    formatted_output += f'<code>{broken_path}</code>|\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'
+                    formatted_output += f'<code>{tracking_id_paths}</code>|\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'
+                    formatted_output += f'<code>{tracking_id_urls}</code>|\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'
+                    formatted_output += f'<code>{country_locale_urls}</code>|\n'
                     return formatted_output
 
 def get_links_from_file(file_path: str) -> list:
@@ -187,4 +142,4 @@ def get_paths_from_file(file_path: str) -> list:
         matches = re.finditer(path_pattern, data)
         for matched_group in matches:
             paths.append(matched_group.group())
-    return paths
+    return paths

markdown-checker-0.0.7/markdown_checker/paths/files_paths_reader.py

@@ -0,0 +1,42 @@
+"""
+This module contains a function to get a list of file paths from a root directory and
+its subdirectories, filtered by file extension.
+
+The main function in this module is `get_files_paths_list`.
+
+Functions:
+- get_files_paths_list(root_path: str, extension: list = None) -> list
+"""
+
+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,
+    filtered by file extensions.
+
+    Keyword arguments:
+    root_path (str): The root directory from which to start the search.
+    extensions (list, optional): A list of file extensions to filter by.
+    Defaults to [".md", ".ipynb"].
+
+    Returns:
+    list: A list of file paths that match the given file extensions.
+    """
+    if extensions is None:
+        extensions = [".md", ".ipynb"]
+
+    sub_folders, files_paths = [], []
+
+    for f in os.scandir(root_path):
+        if f.is_dir():
+            sub_folders.append(f.path)
+        if f.is_file():
+            if os.path.splitext(f.name)[1].lower() in extensions:
+                files_paths.append(f.path)
+
+    for directory in list(sub_folders):
+        sf, f = get_files_paths_list(directory, extensions)
+        sub_folders.extend(sf)
+        files_paths.extend(f)
+    return sub_folders, files_paths

markdown-checker-0.0.7/markdown_checker/validate_markdown.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+"""
+Module providing automatic checks functionality to markdown files 
+following some Guidelines
+"""
+from markdown_checker.inputs.input_arguments import get_input_args
+from markdown_checker.markdown_checker import check_broken_links
+from markdown_checker.paths.files_paths_reader import get_files_paths_list
+
+def main() -> None:
+    """Main program get inputs and run checks"""
+
+    # get input arguments directory, function to run
+    in_arg = get_input_args()
+
+    _, 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']
+    files_paths = [file_path for file_path in files_paths if file_path not in pass_list]
+
+    formatted_output = ""
+
+    # 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")
+            if broken_paths:
+                formatted_output += broken_paths
+        if "check_paths_tracking" in in_arg.func:
+            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")
+            if urls_tracking:
+                formatted_output += urls_tracking
+        if "check_urls_locale" in in_arg.func:
+            urls_locale = check_broken_links(file_path, "url" , "locale")
+            if urls_locale:
+                formatted_output += urls_locale
+    if formatted_output != "":
+        formatted_output = "| File Full Path | Issues |\n|--------|--------|\n" + formatted_output
+        print(formatted_output)
+
+if __name__ == "__main__":
+    main()

{markdown-checker-0.0.5 → markdown-checker-0.0.7/markdown_checker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.0.5
+Version: 0.0.7
 Summary: A markdown validation reporting tool
 Home-page: https://github.com/john0isaac/markdown-checker
 Author: John Aziz
@@ -35,4 +35,4 @@ markdown-checker is a markdown validation reporting tool.
 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.
+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.5 → markdown-checker-0.0.7}/markdown_checker.egg-info/SOURCES.txt

@@ -12,5 +12,7 @@ markdown_checker.egg-info/SOURCES.txt
 markdown_checker.egg-info/dependency_links.txt
 markdown_checker.egg-info/entry_points.txt
 markdown_checker.egg-info/top_level.txt
-markdown_checker/get_input_args/__init__.py
-markdown_checker/get_input_args/get_input_args.py
+markdown_checker/inputs/__init__.py
+markdown_checker/inputs/input_arguments.py
+markdown_checker/paths/__init__.py
+markdown_checker/paths/files_paths_reader.py

{markdown-checker-0.0.5 → markdown-checker-0.0.7}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = markdown-checker
-version = 0.0.5
+version = 0.0.7
 author = John Aziz
 author_email = johnaziz269@gmail.com
 maintainer = John Aziz

markdown-checker-0.0.5/MANIFEST.in

@@ -1,3 +0,0 @@
-include README.md
-include markdown_checker/get_input_args/*
-include setup.cfg

markdown-checker-0.0.5/markdown_checker/validate_markdown.py

@@ -1,45 +0,0 @@
-#!/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()