Markdown-Checker 0.2.3__tar.gz → 0.2.5__tar.gz

{markdown_checker-0.2.3/src/markdown_checker.egg-info → markdown_checker-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: markdown-checker
-Version: 0.2.3
+Version: 0.2.5
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>
@@ -62,6 +62,7 @@ Requires-Dist: mkdocs; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"
 Requires-Dist: mkdocstrings[python]; extra == "docs"
 Requires-Dist: pymdown-extensions; extra == "docs"
+Dynamic: license-file
 
 [![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)

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/pyproject.toml

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

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/__init__.py

@@ -76,32 +76,16 @@ def detect_issues(
         # currently these domains are known to have restrictions on the requests
         skip_domains.extend(
             [
-                "platform.openai.com",
-                "help.openai.com",
+                "openai.com",
                 "beta.openai.com",
-                "marketplace.visualstudio.com",
-                "huggingface.co",
+                "help.openai.com",
+                "platform.openai.com",
+                "vscode.dev",
                 "en.wikipedia.org",
-                "twitter.com",
-                "www.linkedin.com",
-                "make.powerautomate.com",
-                "make.powerapps.com",
                 "www.midjourney.com",
-                "vscode.dev",
+                "www.linkedin.com",
                 "rodtrent.substack.com",
-                "example.com",
-                "www.nuget.org",
-                "www.docker.com",
-                "build.nvidia.com",
-                "dotnet.microsoft.com",
-                "www.gemini.com",
-                "upload.wikimedia.org",
-                "medium.com",
-                "blogs.nvidia.com",
-                "blog.gopenai.com",
-                "towardsdatascience.com",
-                "code.visualstudio.com",
-                "opensource.org",
+                "github.com",
             ]
         )
         with concurrent.futures.ProcessPoolExecutor() as executor:
@@ -165,7 +149,7 @@ class ListOfStrings(click.Option):
     Ref: https://stackoverflow.com/questions/47631914/how-to-pass-several-list-of-arguments-to-click-option
     """
 
-    def type_cast_value(self, ctx, value):
+    def type_cast_value(self, ctx, value) -> list[str]:  # type: ignore
         try:
             if isinstance(value, str):
                 # split the string by comma and remove empty strings
@@ -260,7 +244,7 @@ class ListOfStrings(click.Option):
     "-to",
     "--timeout",
     type=click.IntRange(0, 50),
-    default=10,
+    default=15,
     help="Timeout in seconds for the requests.",
     required=False,
 )
@@ -289,7 +273,7 @@ class ListOfStrings(click.Option):
     required=False,
 )
 @click.version_option(
-    message=(f"%(prog)s, %(version)s\n" f"Python ({platform.python_implementation()}) {platform.python_version()}"),
+    message=(f"%(prog)s, %(version)s\nPython ({platform.python_implementation()}) {platform.python_version()}"),
 )
 def main(
     src: tuple[Path, ...],

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/reports/md_reports/templates/paths/broken.md

@@ -3,4 +3,4 @@
 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 the file paths and associated broken paths inside them.

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/reports/md_reports/templates/paths/tracking.md

@@ -3,4 +3,4 @@
 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 the file paths and associated paths inside them.

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/reports/md_reports/templates/urls/broken.md

@@ -2,4 +2,4 @@
 
 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.

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/reports/md_reports/templates/urls/locale.md

@@ -3,4 +3,4 @@
 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.
+Check the file paths and associated URLs inside them.

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/reports/md_reports/templates/urls/tracking.md

@@ -3,4 +3,4 @@
 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 the file paths and associated URLs inside them.

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/urls.py

@@ -27,7 +27,7 @@ class MarkdownURL(MarkdownLinkBase):
         """
         return self.parsed_url.netloc
 
-    def is_alive(self, timeout: int = 10, retries: int = 3) -> bool:
+    def is_alive(self, timeout: int = 15, retries: int = 3) -> bool:
         """
         Check if the URL is alive
 
@@ -38,14 +38,18 @@ class MarkdownURL(MarkdownLinkBase):
         Returns:
             bool: True if the URL is alive, False otherwise
         """
+        headers = {
+            "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
+            "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)",
+        }
         for _ in range(retries):
             try:
-                response = requests.head(self.link, timeout=timeout, allow_redirects=True)
-                if response.status_code == 200:
+                response = requests.head(self.link, timeout=timeout, allow_redirects=True, headers=headers)
+                if 200 <= response.status_code < 300:
                     return True
                 else:
-                    response = requests.get(self.link, timeout=timeout, allow_redirects=True)
-                    if response.status_code == 200:
+                    response = requests.get(self.link, timeout=timeout, allow_redirects=True, headers=headers)
+                    if 200 <= response.status_code < 300:
                         return True
             except requests.RequestException:
                 continue

markdown_checker-0.2.5/src/markdown_checker/utils/logging.py

@@ -0,0 +1,19 @@
+"""
+Utilities for logging config.
+"""
+
+import logging
+
+
+def setup_logging(
+    level: int = logging.INFO,
+    format: str = "[%(asctime)s] %(levelname)s in %(module)s: %(message)s",
+) -> None:
+    """
+    Setup logging
+
+    Args:
+        level (int): The logging level
+        format (str): The logging format
+    """
+    logging.basicConfig(level=level, format=format)

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker/utils/spinner.py

@@ -44,7 +44,7 @@ class Spinner:
         self.start()
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
+    def __exit__(self, exc_type, exc_val, exc_tb):  # type: ignore
         if self.disable:
             return False
         self.stop()

{markdown_checker-0.2.3 → markdown_checker-0.2.5/src/markdown_checker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: markdown-checker
-Version: 0.2.3
+Version: 0.2.5
 Summary: A markdown link validation reporting tool.
 Author-email: John Aziz <johnaziz269@gmail.com>
 Maintainer-email: John Aziz <johnaziz269@gmail.com>
@@ -62,6 +62,7 @@ Requires-Dist: mkdocs; extra == "docs"
 Requires-Dist: mkdocs-material; extra == "docs"
 Requires-Dist: mkdocstrings[python]; extra == "docs"
 Requires-Dist: pymdown-extensions; extra == "docs"
+Dynamic: license-file
 
 [![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)

{markdown_checker-0.2.3 → markdown_checker-0.2.5}/src/markdown_checker.egg-info/SOURCES.txt

@@ -25,5 +25,6 @@ src/markdown_checker/utils/__init__.py
 src/markdown_checker/utils/extract_links.py
 src/markdown_checker/utils/format_output.py
 src/markdown_checker/utils/list_files.py
+src/markdown_checker/utils/logging.py
 src/markdown_checker/utils/spinner.py
 tests/test_markdown_checker.py