Markdown-Checker 0.2.0__tar.gz → 0.2.1__tar.gz

{markdown_checker-0.2.0/src/markdown_checker.egg-info → markdown_checker-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.2.0
+Version: 0.2.1
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>

{markdown_checker-0.2.0 → markdown_checker-0.2.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "markdown-checker"
 description= "A markdown link validation reporting tool."
-version = "0.2.0"
+version = "0.2.1"
 authors = [{ name = "John Aziz", email = "johnaziz269@gmail.com" }]
 maintainers = [{ name = "John Aziz", email = "johnaziz269@gmail.com" }]
 license = {file = "LICENSE"}

{markdown_checker-0.2.0 → markdown_checker-0.2.1}/src/markdown_checker/__init__.py

@@ -22,7 +22,9 @@ from markdown_checker.utils.list_files import get_files_paths_list
 from markdown_checker.utils.spinner import spinner
 
 
-def check_url(url: MarkdownURL, skip_domains: list[str], skip_urls_containing: list[str], timeout: int, retries: int):
+def check_url(
+    url: MarkdownURL, skip_domains: list[str], skip_urls_containing: list[str], timeout: int, retries: int
+) -> Union[None, MarkdownURL]:
     if any(url.host_name().lower() in domain.lower() for domain in skip_domains) or any(
         url.link in substring for substring in skip_urls_containing
     ):
@@ -94,6 +96,11 @@ def detect_issues(
                 "dotnet.microsoft.com",
                 "www.gemini.com",
                 "upload.wikimedia.org",
+                "medium.com",
+                "blogs.nvidia.com",
+                "blog.gopenai.com",
+                "towardsdatascience.com",
+                "code.visualstudio.com",
             ]
         )
         with concurrent.futures.ProcessPoolExecutor() as executor:
@@ -150,44 +157,83 @@ def detect_issues(
     return detected_issues, links_count
 
 
+class ListOfStrings(click.Option):
+    """
+    Helper class to parse a list of strings from the command line.
+
+    Ref: https://stackoverflow.com/questions/47631914/how-to-pass-several-list-of-arguments-to-click-option
+    """
+
+    def type_cast_value(self, ctx, value):
+        try:
+            if isinstance(value, str):
+                # split the string by comma and remove empty strings
+                return list(filter(None, value.split(",")))
+            elif isinstance(value, list):
+                return value
+            else:
+                raise Exception
+        except Exception:
+            raise click.BadParameter(value)
+
+
 @click.command()
 @click.option(
     "-d",
     "--dir",
-    type=click.Path(exists=True, file_okay=False, dir_okay=True, readable=True),
+    type=click.Path(path_type=Path, exists=True, file_okay=False, dir_okay=True, readable=True),
     help="Path to the root directory to check.",
     required=True,
 )
+@click.option(
+    "-f",
+    "--func",
+    type=click.Choice(
+        [
+            "check_broken_paths",
+            "check_broken_urls",
+            "check_paths_tracking",
+            "check_urls_tracking",
+            "check_urls_locale",
+        ]
+    ),
+    help="Function to be executed.",
+    required=True,
+)
 @click.option(
     "-ext",
     "--extensions",
+    cls=ListOfStrings,
     type=list[str],
     default=[".md", ".ipynb"],
     help="File extensions to filter the files.",
-    required=True,
+    required=False,
 )
 @click.option(
     "-td",
     "--tracking-domains",
+    cls=ListOfStrings,
     type=list[str],
     default=["github.com", "microsoft.com", "visualstudio.com", "aka.ms", "azure.com"],
     help="List of tracking domains to check.",
-    required=True,
+    required=False,
 )
 @click.option(
     "-sf",
     "--skip-files",
+    cls=ListOfStrings,
     type=list[str],
     default=[
         "CODE_OF_CONDUCT.md",
         "SECURITY.md",
     ],
     help="List of file names to skip check.",
-    required=True,
+    required=False,
 )
 @click.option(
     "-sd",
     "--skip-domains",
+    cls=ListOfStrings,
     type=list[str],
     default=[],
     help="List of domains to skip check.",
@@ -196,37 +242,23 @@ def detect_issues(
 @click.option(
     "-suc",
     "--skip-urls-containing",
+    cls=ListOfStrings,
     type=list[str],
     default=["https://www.microsoft.com/en-us/security/blog", "video-embed.html"],
     help="List of urls to skip check.",
     required=False,
 )
-@click.option(
-    "-f",
-    "--func",
-    type=click.Choice(
-        [
-            "check_broken_paths",
-            "check_broken_urls",
-            "check_paths_tracking",
-            "check_urls_tracking",
-            "check_urls_locale",
-        ]
-    ),
-    help="Function to be executed.",
-    required=True,
-)
 @click.option(
     "-gu",
     "--guide-url",
     type=str,
     help="Full url of your contributing guide.",
-    required=True,
+    required=False,
 )
 @click.option(
     "-to",
     "--timeout",
-    type=int,
+    type=click.IntRange(0, 50),
     default=10,
     help="Timeout in seconds for the requests.",
     required=False,
@@ -234,7 +266,7 @@ def detect_issues(
 @click.option(
     "-rt",
     "--retries",
-    type=int,
+    type=click.IntRange(0, 10),
     default=3,
     help="Number of retries for the requests.",
     required=False,
@@ -245,12 +277,12 @@ def detect_issues(
     type=str,
     default="comment",
     help="Name of the output file.",
-    required=True,
+    required=False,
 )
 @click.argument(
     "src",
     nargs=-1,
-    type=click.Path(exists=True, file_okay=True, dir_okay=True, readable=True),
+    type=click.Path(path_type=Path, exists=True, file_okay=True, dir_okay=True, readable=True),
     is_eager=True,
     metavar="SRC ...",
     required=False,
@@ -259,23 +291,22 @@ def detect_issues(
     message=(f"%(prog)s, %(version)s\n" f"Python ({platform.python_implementation()}) {platform.python_version()}"),
 )
 def main(
-    src: tuple[str, ...],
-    dir: str,
+    src: tuple[Path, ...],
+    dir: Path,
     func: str,
-    guide_url: str,
+    guide_url: Union[str, None],
     extensions: list[str],
     skip_files: list[str],
     skip_domains: list[str],
     skip_urls_containing: list[str],
+    tracking_domains: list[str],
     timeout: int,
     retries: int,
-    tracking_domains: list[str],
     output_file_name: str,
 ) -> None:
     """A markdown link validation reporting tool."""
-    _ = tuple(Path(item) for item in src) or (Path("./"),)  # default to current directory
-
-    _, files_paths = get_files_paths_list(Path(dir), extensions)
+    _ = src or (Path("./"),)  # default to current directory
+    _, files_paths = get_files_paths_list(dir, extensions)
 
     # remove files from skip_files list
     files_paths = [file_path for file_path in files_paths if file_path.name not in skip_files]

{markdown_checker-0.2.0 → markdown_checker-0.2.1}/src/markdown_checker/reports/md_reports/generator.py

@@ -1,31 +1,29 @@
 import pathlib
+from typing import Union
 
 from markdown_checker.reports.generator_base import GeneratorBase
 
 
 class MarkdownGenerator(GeneratorBase):
     current_dir = pathlib.Path(__file__).parent
-    check_broken_paths_template = open(current_dir / "templates/paths/broken.md").read()
-    check_broken_urls_template = open(current_dir / "templates/urls/broken.md").read()
-    check_paths_tracking_template = open(current_dir / "templates/paths/tracking.md").read()
-    check_urls_tracking_template = open(current_dir / "templates/urls/tracking.md").read()
-    check_urls_locale_template = open(current_dir / "templates/urls/locale.md").read()
-    templates = {
-        "check_broken_paths": check_broken_paths_template,
-        "check_broken_urls": check_broken_urls_template,
-        "check_paths_tracking": check_paths_tracking_template,
-        "check_urls_tracking": check_urls_tracking_template,
-        "check_urls_locale": check_urls_locale_template,
-    }
 
     def __init__(
         self,
+        contributing_guide_url: Union[str, None] = None,
         output_file_name: str = "comment",
-        contributing_guide_url: str = "https://github.com/john0isaac/markdown-checker/blob/main/CONTRIBUTING.md",
     ) -> None:
+        self.templates = {
+            "check_broken_paths": open(self.current_dir / "templates/paths/broken.md").read(),
+            "check_broken_urls": open(self.current_dir / "templates/urls/broken.md").read(),
+            "check_paths_tracking": open(self.current_dir / "templates/paths/tracking.md").read(),
+            "check_urls_tracking": open(self.current_dir / "templates/urls/tracking.md").read(),
+            "check_urls_locale": open(self.current_dir / "templates/urls/locale.md").read(),
+        }
         self.output_file_name = output_file_name
         self.contributing_guide_line = (
-            f" For more details, check our [Contributing Guide]({contributing_guide_url}).\n\n"
+            (f" For more details, check our [Contributing Guide]({contributing_guide_url}).\n\n")
+            if contributing_guide_url
+            else "\n\n"
         )
 
     def _write_file(self, generated_text: str) -> None:
@@ -60,8 +58,3 @@ class MarkdownGenerator(GeneratorBase):
         """
         generated_text = self._generate_text(function_name=function_name, formatted_output=formatted_output)
         self._write_file(generated_text)
-
-
-if __name__ == "__main__":
-    md_generator = MarkdownGenerator()
-    md_generator.generate("check_broken_paths", "This is a test")

{markdown_checker-0.2.0 → markdown_checker-0.2.1/src/markdown_checker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: markdown-checker
-Version: 0.2.0
+Version: 0.2.1
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>