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

markdown-checker-0.0.8/MANIFEST.in

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.0.7
+Version: 0.0.8
 Summary: A markdown validation reporting tool
 Home-page: https://github.com/john0isaac/markdown-checker
 Author: John Aziz
@@ -30,9 +30,11 @@ License-File: LICENSE
 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.
+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.7 → markdown-checker-0.0.8}/README.md

@@ -7,9 +7,11 @@
 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.
+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.8/markdown_checker/check_markdown.py

@@ -0,0 +1,52 @@
+"""
+Module providing automatic checks functionality to markdown files 
+following some Guidelines
+"""
+from markdown_checker.links.link_operations import (
+    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:
+    """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"|<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'<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'<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'<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'<code>{country_locale_urls}</code>|\n'
+                    return formatted_output

markdown-checker-0.0.8/markdown_checker/generators/md_generator.py

@@ -0,0 +1,51 @@
+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_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.
+
+Check the file paths and associated paths inside them."""
+CHECK_URLS_TRACKING = """# Check Missing Tracking from URLs
+
+We have automatically detected missing tracking id from the following URLs in your lessons. Review and add tracking to URLs to resolve this issue.
+
+Check the file paths and associated URLs inside them."""
+CHECK_URLS_LOCALE = """# Check Country Locale in URLs
+
+We have automatically detected added country locale to URLs in your lessons. Review and remove country specific locale from URLs to resolve this issue.
+
+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:
+    """Generate markdown file based on the formatted output, function name, and contributing guide URL.
+
+    Args:
+        formatted_output (str): The formatted output to be written to the markdown file.
+        function_name (str): The name of the function to determine the header for the markdown file.
+        contributing_guide_url (str): The URL of the contributing guide to be included in the markdown file.
+
+    Raises:
+        ValueError: If an invalid function name is provided.
+
+    """
+    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
+    elif function_name == "check_paths_tracking":
+        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
+    elif function_name == "check_urls_locale":
+        formatted_output = CHECK_URLS_LOCALE + contributing_guide_line + formatted_output
+    else:
+        raise ValueError("Invalid function name")
+
+    write_md_file(formatted_output)

{markdown-checker-0.0.7 → markdown-checker-0.0.8}/markdown_checker/inputs/input_arguments.py

@@ -33,4 +33,7 @@ def get_input_args() -> None:
                                  'check_urls_tracking',
                                  'check_urls_locale'])
 
-    return parser.parse_args()
+    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.7/markdown_checker/markdown_checker.py → markdown-checker-0.0.8/markdown_checker/links/link_operations.py

@@ -1,50 +1,5 @@
-"""
-Module providing automatic checks functionality to markdown files 
-following some Guidelines
-"""
-import os
 import re
-
-# Helper Functions
-
-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"|<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'<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'<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'<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'<code>{country_locale_urls}</code>|\n'
-                    return formatted_output
+import os
 
 def get_links_from_file(file_path: str) -> list:
     """function to get an array of markdown links from a file

{markdown-checker-0.0.7 → markdown-checker-0.0.8}/markdown_checker/validate_markdown.py

@@ -4,8 +4,9 @@ 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.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
 
 def main() -> None:
     """Main program get inputs and run checks"""
@@ -41,6 +42,7 @@ def main() -> None:
     if 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.7 → markdown-checker-0.0.8/markdown_checker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.0.7
+Version: 0.0.8
 Summary: A markdown validation reporting tool
 Home-page: https://github.com/john0isaac/markdown-checker
 Author: John Aziz
@@ -30,9 +30,11 @@ License-File: LICENSE
 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.
+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.7 → markdown-checker-0.0.8}/markdown_checker.egg-info/SOURCES.txt

@@ -5,14 +5,19 @@ pyproject.toml
 setup.cfg
 setup.py
 markdown_checker/__init__.py
-markdown_checker/markdown_checker.py
+markdown_checker/check_markdown.py
 markdown_checker/validate_markdown.py
 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/top_level.txt
+markdown_checker/generators/__init__.py
+markdown_checker/generators/md_generator.py
 markdown_checker/inputs/__init__.py
 markdown_checker/inputs/input_arguments.py
+markdown_checker/links/__init__.py
+markdown_checker/links/link_operations.py
 markdown_checker/paths/__init__.py
-markdown_checker/paths/files_paths_reader.py
+markdown_checker/paths/files_paths_reader.py
+tests/test_markdown_checker.py

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

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

markdown-checker-0.0.8/tests/test_markdown_checker.py

@@ -0,0 +1,46 @@
+"""
+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:")

markdown-checker-0.0.7/MANIFEST.in

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