Markdown-Checker 0.1.2__tar.gz → 0.1.4__tar.gz

markdown_checker-0.1.4/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.1
+Name: markdown-checker
+Version: 0.1.4
+Summary: A markdown link validation reporting tool
+Author-email: John Aziz <johnaziz269@gmail.com>
+Maintainer-email: John Aziz <johnaziz269@gmail.com>
+License: 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.
+        
+Project-URL: Homepage, https://github.com/john0isaac/markdown-checker
+Project-URL: Documentation, https://markdown-checker.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/john0isaac/markdown-checker/issues
+Project-URL: Contributing, https://github.com/john0isaac/markdown-checker/pulls
+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
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: types-requests
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+
+[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
+[![Documentation Status](https://readthedocs.org/projects/markdown-checker/badge/?version=latest)](https://markdown-checker.readthedocs.io/en/latest/?badge=latest)
+[![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 link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.
+
+## Installation
+
+Install the package:
+
+```bash
+pip install markdown-checker
+```
+
+### Documentation
+
+- [Full documentation](https://markdown-checker.readthedocs.io/en/latest/).
+
+## 1, 2, 3 - 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
+
+You can run this tool 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.
+
+# Usage
+
+The library provides the following functions:
+
+- [Usage](#usage)
+  - [`check_broken_paths`](#check_broken_paths)
+  - [`check_broken_urls`](#check_broken_urls)
+  - [`check_urls_locale`](#check_urls_locale)
+  - [`check_paths_tracking`](#check_paths_tracking)
+  - [`check_urls_tracking`](#check_urls_tracking)
+
+## `check_broken_paths`
+
+This function ensures that any relative path in your files are 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_urls_locale`
+
+This function checks if country specific locale is present in URLs.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## `check_paths_tracking`
+
+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_urls_tracking`
+
+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.2 → markdown_checker-0.1.4}/README.md

@@ -1,25 +1,50 @@
 [![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
+[![Documentation Status](https://readthedocs.org/projects/markdown-checker/badge/?version=latest)](https://markdown-checker.readthedocs.io/en/latest/?badge=latest)
 [![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.
+markdown-checker is a markdown link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.
 
-# How To
+## Installation
+
+Install the package:
+
+```bash
+pip install markdown-checker
+```
+
+### Documentation
+
+- [Full documentation](https://markdown-checker.readthedocs.io/en/latest/).
+
+## 1, 2, 3 - 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.
+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
+## Using `markdown-checker` in GitHub Actions
+
+You can run this tool within a GitHub workflow using the [action-check-markdown](https://github.com/marketplace/actions/check-markdown) GitHub action.
 
-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.
+The action will automatically post the output of the tool to your GitHub pull request as a comment.
 
-# Supported Functions
+# Usage
 
-## Check broken relative paths
-This function ensures that any relative path in your files is working.
+The library provides the following functions:
+
+- [Usage](#usage)
+  - [`check_broken_paths`](#check_broken_paths)
+  - [`check_broken_urls`](#check_broken_urls)
+  - [`check_urls_locale`](#check_urls_locale)
+  - [`check_paths_tracking`](#check_paths_tracking)
+  - [`check_urls_tracking`](#check_urls_tracking)
+
+## `check_broken_paths`
+
+This function ensures that any relative path in your files are working.
 
 Example:
 
@@ -27,7 +52,8 @@ Example:
 markdown-checker -d . -f check_broken_paths -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
 ```
 
-## Check broken URLs
+## `check_broken_urls`
+
 This function ensures that any web URL in your files is working and returning 200 status code.
 
 Example:
@@ -36,8 +62,9 @@ Example:
 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. 
+## `check_urls_locale`
+
+This function checks if country specific locale is present in URLs.
 
 Example:
 
@@ -45,7 +72,8 @@ Example:
 markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
 ```
 
-## Check Contributor ID missing from paths
+## `check_paths_tracking`
+
 This function ensures that any relative path has tracking in it.
 
 Example:
@@ -54,7 +82,8 @@ Example:
 markdown-checker -d . -f check_paths_tracking -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
 ```
 
-## Check Contributor ID missing from URLs
+## `check_urls_tracking`
+
 This function ensures that any URL has tracking in it.
 
 Example:

markdown_checker-0.1.4/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "markdown-checker"
+description= "A markdown link validation reporting tool"
+version = "0.1.4"
+authors = [{ name = "John Aziz", email = "johnaziz269@gmail.com" }]
+maintainers = [{ name = "John Aziz", email = "johnaziz269@gmail.com" }]
+license = {file = "LICENSE"}
+readme = "README.md"
+
+requires-python = ">=3.8"
+dependencies = [
+    "requests",
+    "types-requests",
+    ]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    ]
+
+[project.urls]
+Homepage = "https://github.com/john0isaac/markdown-checker"
+Documentation = "https://markdown-checker.readthedocs.io/en/latest/"
+Issues = "https://github.com/john0isaac/markdown-checker/issues"
+Contributing = "https://github.com/john0isaac/markdown-checker/pulls"
+Releases = "https://github.com/john0isaac/markdown-checker/releases"
+
+[tool.setuptools.package-data]
+"*" = ["*.html", "*.txt", "*.xml", "*.md"]
+
+[project.optional-dependencies]
+dev = [
+    "pytest",
+    "pytest-cov",
+    "pre-commit",
+    "ruff",
+    "black",
+    "mypy",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"
+src = ["src"]
+output-format = "full"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP"]
+
+[tool.black]
+line-length = 120
+target-version = ["py38"]
+
+[project.scripts]
+markdown-checker = "markdown_checker.validate_markdown:main"

markdown_checker-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

{markdown-checker-0.1.2 → markdown_checker-0.1.4/src}/markdown_checker/check_markdown.py

@@ -3,6 +3,8 @@ Module providing automatic checks functionality to markdown files
 following some Guidelines
 """
 
+from typing import List
+
 from markdown_checker.links.link_operations import (
     check_paths_exists,
     check_url_alive,
@@ -57,14 +59,15 @@ def check_broken_links(file_path: str, link_type: str, check_type: str) -> str:
                 if len(dead_urls) > 0:
                     formatted_output += format_links(dead_urls)
                     return formatted_output
+    return ""
 
 
-def format_links(links: list) -> str:
+def format_links(links: List[str]) -> str:
     """
-    Formats a list of links into a string with numbered bullets.
+    Formats a List of links into a string with numbered bullets.
 
     Args:
-        links (list): A list of links.
+        links (List): A List of links.
 
     Returns:
         str: The formatted string with numbered bullets.

{markdown-checker-0.1.2 → markdown_checker-0.1.4/src}/markdown_checker/generators/md_generator.py

@@ -1,26 +1,30 @@
 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.
+We have automatically detected the following broken relative paths in your files.
+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.
+We have automatically detected the following broken URLs in your files. Review and fix the paths to resolve this issue.
 
-Check the file paths and associated broken urls inside them."""
+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.
+We have automatically detected missing tracking IDs from the following relative paths in your files.
+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.
+We have automatically detected missing tracking IDs from the following URLs in your files.
+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.
+We have automatically detected added country locale to URLs in your files.
+Review and remove country-specific locale from URLs to resolve this issue.
 
 Check the file paths and associated URLs inside them."""
 
@@ -31,9 +35,7 @@ def write_md_file(generated_md: str) -> None:
         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:
@@ -47,25 +49,15 @@ def generate_md(
     """
     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
-        )
+        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.1.2 → markdown_checker-0.1.4/src}/markdown_checker/inputs/input_arguments.py

@@ -6,7 +6,7 @@ following some Guidelines
 import argparse
 
 
-def get_input_args() -> None:
+def get_input_args() -> argparse.Namespace:
     """
     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

{markdown-checker-0.1.2 → markdown_checker-0.1.4/src}/markdown_checker/links/link_operations.py

@@ -1,13 +1,14 @@
 import os
 import re
+from typing import List
 
 
-def get_links_from_file(file_path: str) -> list:
+def get_links_from_file(file_path: str) -> List[str]:
     """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, encoding="utf-8") as file:
         data = file.read()
         link_pattern = re.compile(r"\]\((.*?)\)| \)")
         matches = re.finditer(link_pattern, data)
@@ -17,8 +18,8 @@ def get_links_from_file(file_path: str) -> list:
     return all_links
 
 
-def get_urls_from_links(all_links: list) -> list:
-    """function to get an array of urls from a list"""
+def get_urls_from_links(all_links: List[str]) -> List[str]:
+    """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@:%_\+.~#?&\/\/=]*)"
@@ -38,8 +39,8 @@ def get_urls_from_links(all_links: list) -> list:
     return urls
 
 
-def get_paths_from_links(all_links: list) -> list:
-    """function to get relative paths from a list
+def get_paths_from_links(all_links: List[str]) -> List[str]:
+    """function to get relative paths from a List
     flags paths that start with ./ or ../
     """
     paths = []
@@ -49,34 +50,29 @@ def get_paths_from_links(all_links: list) -> list:
         link = link.split(" ")[0]
         matches = re.findall(path_pattern, link)
         if matches:
-            paths.append(link)
+            paths.append(link.split("#")[0])
     return paths
 
 
-def check_paths_exists(file_path: str, paths: list) -> list:
+def check_paths_exists(file_path: str, paths: List[str]) -> List[str]:
     """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))
-        ):
+        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[str]) -> List[str]:
     """function checks if a url has country locale
     flags urls that have ==> /en-us/
     """
     country_locale = []
     for url in urls:
-        if (
-            "video-embed.html" in url
-            or "https://www.microsoft.com/en-us/security/blog" in url
-        ):
+        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)
@@ -85,7 +81,7 @@ def check_url_locale(urls: list) -> list:
     return country_locale
 
 
-def check_url_tracking(urls: list) -> list:
+def check_url_tracking(urls: List[str]) -> List[str]:
     """function checks if a url has tracking id
     flags urls missing ==> (? or &) plus WT.mc_id= or wt.mc_id=
     """
@@ -98,8 +94,8 @@ def check_url_tracking(urls: list) -> list:
     return tracking_id
 
 
-def check_url_alive(urls: list) -> list:
-    import requests
+def check_url_alive(urls: List[str]) -> List[str]:
+    import requests  # type: ignore
 
     broken_urls = []
     for url in urls:
@@ -116,10 +112,10 @@ def check_url_alive(urls: list) -> list:
 
 
 # DEPRECATED
-def get_urls_from_file(file_path: str) -> list:
+def get_urls_from_file(file_path: str) -> List[str]:
     """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, 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@:%_\+.~#?&\/\/=]*)"
@@ -130,14 +126,12 @@ def get_urls_from_file(file_path: str) -> list:
     return urls
 
 
-def get_paths_from_file(file_path: str) -> list:
+def get_paths_from_file(file_path: str) -> List[str]:
     """function to get relative paths from a file"""
     paths = []
-    with open(file_path, "r", encoding="utf-8") as file:
+    with open(file_path, 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.1.2 → markdown_checker-0.1.4/src}/markdown_checker/paths/files_paths_reader.py

@@ -5,13 +5,14 @@ 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
+- get_files_paths_list(root_path: str, extension: list = []) -> list
 """
 
 import os
+from typing import List, Tuple
 
 
-def get_files_paths_list(root_path: str, extensions: list = None) -> list:
+def get_files_paths_list(root_path: str, extensions: List[str] = []) -> Tuple[List[str], List[str]]:
     """
     function returns a list of files in a directory and its subdirectories,
     filtered by file extensions.
@@ -24,10 +25,11 @@ def get_files_paths_list(root_path: str, extensions: list = None) -> list:
     Returns:
     list: A list of file paths that match the given file extensions.
     """
-    if extensions is None:
+    if len(extensions) == 0:
         extensions = [".md", ".ipynb"]
 
-    sub_folders, files_paths = [], []
+    sub_folders: List[str] = []
+    files_paths: List[str] = []
 
     for f in os.scandir(root_path):
         if f.is_dir():
@@ -37,7 +39,7 @@ def get_files_paths_list(root_path: str, extensions: list = None) -> list:
                 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)
+        sub_dir_sub_folders, sub_dir_file_paths = get_files_paths_list(directory, extensions)
+        sub_folders.extend(sub_dir_sub_folders)
+        files_paths.extend(sub_dir_file_paths)
     return sub_folders, files_paths

{markdown-checker-0.1.2 → markdown_checker-0.1.4/src}/markdown_checker/validate_markdown.py

@@ -21,8 +21,8 @@ def main() -> None:
     pass_list = [
         "./CODE_OF_CONDUCT.md",
         "./SECURITY.md",
-        ".\CODE_OF_CONDUCT.md",
-        ".\SECURITY.md",
+        ".\\CODE_OF_CONDUCT.md",
+        ".\\SECURITY.md",
     ]
     files_paths = [file_path for file_path in files_paths if file_path not in pass_list]
 
@@ -51,9 +51,7 @@ def main() -> None:
             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)
 

markdown_checker-0.1.4/src/markdown_checker.egg-info/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.1
+Name: markdown-checker
+Version: 0.1.4
+Summary: A markdown link validation reporting tool
+Author-email: John Aziz <johnaziz269@gmail.com>
+Maintainer-email: John Aziz <johnaziz269@gmail.com>
+License: 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.
+        
+Project-URL: Homepage, https://github.com/john0isaac/markdown-checker
+Project-URL: Documentation, https://markdown-checker.readthedocs.io/en/latest/
+Project-URL: Issues, https://github.com/john0isaac/markdown-checker/issues
+Project-URL: Contributing, https://github.com/john0isaac/markdown-checker/pulls
+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
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: types-requests
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+
+[![PyPi](https://img.shields.io/pypi/v/markdown-checker)](https://pypi.org/project/markdown-checker/)
+[![Documentation Status](https://readthedocs.org/projects/markdown-checker/badge/?version=latest)](https://markdown-checker.readthedocs.io/en/latest/?badge=latest)
+[![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 link validation reporting tool. It provides a couple of functions to validate relative paths and web URLs.
+
+## Installation
+
+Install the package:
+
+```bash
+pip install markdown-checker
+```
+
+### Documentation
+
+- [Full documentation](https://markdown-checker.readthedocs.io/en/latest/).
+
+## 1, 2, 3 - 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
+
+You can run this tool 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.
+
+# Usage
+
+The library provides the following functions:
+
+- [Usage](#usage)
+  - [`check_broken_paths`](#check_broken_paths)
+  - [`check_broken_urls`](#check_broken_urls)
+  - [`check_urls_locale`](#check_urls_locale)
+  - [`check_paths_tracking`](#check_paths_tracking)
+  - [`check_urls_tracking`](#check_urls_tracking)
+
+## `check_broken_paths`
+
+This function ensures that any relative path in your files are 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_urls_locale`
+
+This function checks if country specific locale is present in URLs.
+
+Example:
+
+```bash
+markdown-checker -d . -f check_urls_locale -gu https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md
+```
+
+## `check_paths_tracking`
+
+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_urls_tracking`
+
+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.4/src/markdown_checker.egg-info/SOURCES.txt

@@ -0,0 +1,22 @@
+LICENSE
+README.md
+pyproject.toml
+src/markdown_checker/__init__.py
+src/markdown_checker/check_markdown.py
+src/markdown_checker/py.typed
+src/markdown_checker/validate_markdown.py
+src/markdown_checker.egg-info/PKG-INFO
+src/markdown_checker.egg-info/SOURCES.txt
+src/markdown_checker.egg-info/dependency_links.txt
+src/markdown_checker.egg-info/entry_points.txt
+src/markdown_checker.egg-info/requires.txt
+src/markdown_checker.egg-info/top_level.txt
+src/markdown_checker/generators/__init__.py
+src/markdown_checker/generators/md_generator.py
+src/markdown_checker/inputs/__init__.py
+src/markdown_checker/inputs/input_arguments.py
+src/markdown_checker/links/__init__.py
+src/markdown_checker/links/link_operations.py
+src/markdown_checker/paths/__init__.py
+src/markdown_checker/paths/files_paths_reader.py
+tests/test_markdown_checker.py

markdown_checker-0.1.4/src/markdown_checker.egg-info/requires.txt

@@ -0,0 +1,10 @@
+requests
+types-requests
+
+[dev]
+pytest
+pytest-cov
+pre-commit
+ruff
+black
+mypy

{markdown-checker-0.1.2 → markdown_checker-0.1.4}/tests/test_markdown_checker.py

@@ -5,7 +5,7 @@ Module to check paths in markdown files.
 import subprocess
 
 
-def check_broken_paths():
+def check_broken_paths() -> None:
     """
     Function to check for broken paths.
     """
@@ -24,7 +24,7 @@ def check_broken_paths():
     )
 
 
-def check_broken_urls():
+def check_broken_urls() -> None:
     """
     Function to check for broken paths.
     """
@@ -43,7 +43,7 @@ def check_broken_urls():
     )
 
 
-def check_paths_tracking():
+def check_paths_tracking() -> None:
     """
     Function to check paths tracking.
     """
@@ -62,7 +62,7 @@ def check_paths_tracking():
     )
 
 
-def check_urls_tracking():
+def check_urls_tracking() -> None:
     """
     Function to check URLs tracking.
     """
@@ -81,7 +81,7 @@ def check_urls_tracking():
     )
 
 
-def check_urls_locale():
+def check_urls_locale() -> None:
     """
     Function to check URLs locale.
     """
@@ -113,12 +113,20 @@ try:
         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"
+                """
+                Do you want to:
+                (1) Run check_broken_paths
+                (2) Run check_broken_urls
+                (3) Run check_paths_tracking
+                (4) Run check_urls_tracking
+                (5) Run check_urls_locale
+
+                """
             ).split(),
         )
     )
 except ValueError:
-    print("Please input number")
+    print("Please input number.")
 
 for choice in choices:
     if 0 < choice and choice < 6:

markdown-checker-0.1.2/MANIFEST.in

@@ -1,6 +0,0 @@
-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.1.2/PKG-INFO

@@ -1,88 +0,0 @@
-Metadata-Version: 2.1
-Name: markdown-checker
-Version: 0.1.2
-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
-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/)
-
-[![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.1.2/markdown_checker.egg-info/PKG-INFO

@@ -1,88 +0,0 @@
-Metadata-Version: 2.1
-Name: markdown-checker
-Version: 0.1.2
-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
-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/)
-
-[![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.1.2/markdown_checker.egg-info/SOURCES.txt

@@ -1,24 +0,0 @@
-LICENSE
-MANIFEST.in
-README.md
-pyproject.toml
-setup.cfg
-setup.py
-markdown_checker/__init__.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/requires.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
-tests/test_markdown_checker.py

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

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

markdown-checker-0.1.2/pyproject.toml

@@ -1,3 +0,0 @@
-[build-system]
-requires = ["setuptools>=61.0", "wheel"]
-build-backend = "setuptools.build_meta"

markdown-checker-0.1.2/setup.cfg

@@ -1,40 +0,0 @@
-[metadata]
-name = markdown-checker
-version = 0.1.2
-author = John Aziz
-author_email = johnaziz269@gmail.com
-maintainer = John Aziz
-maintainer_email = johnaziz269@gmail.com
-description = A markdown validation reporting tool
-long_description = file: README.md
-long_description_content_type = text/markdown
-license = MIT
-url = https://github.com/john0isaac/markdown-checker
-requires_python = ">=3.8"
-project_urls = 
-	Bug Tracker = https://github.com/john0isaac/markdown-checker/issues
-	Contributing = https://github.com/john0isaac/markdown-checker/pulls
-	Source Code = https://github.com/john0isaac/markdown-checker
-	Releases = https://github.com/john0isaac/markdown-checker/releases
-classifiers = 
-	Development Status :: 5 - Production/Stable
-	License :: OSI Approved :: MIT License
-	Operating System :: OS Independent
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3.8
-
-[options]
-install_requires = 
-	requests
-include_package_data = True
-packages = find:
-python_requires = >=3.8
-
-[options.entry_points]
-console_scripts = 
-	markdown-checker = markdown_checker.validate_markdown:main
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

markdown-checker-0.1.2/setup.py

@@ -1,3 +0,0 @@
-from setuptools import setup
-
-setup()