Python Dependency Update / Docs Dependencies / Remove Black (#55)

* dropping support for py 3.8 in anticipation of oct 2024

* separate dependencies and add docs depnds

* remove black and use ruff only

* track workflow too

* fix 3.8 linting issues

Author: john0isaac

.github/workflows/python-types-lint-format.yaml

@@ -6,11 +6,13 @@ on:
     branches: [ main ]
     paths:
       - '**.py'
+      - ".github/workflows/python-types-lint-format.yaml"
 
   pull_request:
     branches: [ main ]
     paths:
       - '**.py'
+      - ".github/workflows/python-types-lint-format.yaml"
 
 permissions:
   contents: read
@@ -23,7 +25,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python_version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
@@ -36,16 +38,16 @@ jobs:
         python3 -m pip install -e '.[dev]'
 
     - name: Run type check
-      run: python -m mypy .
+      run: python3 -m mypy .
 
-  python-lint-check:
+  python-lint-format-check:
     if: ${{ always() }} # Always run even if a matrix candidate fails
-    name: Python ${{ matrix.python_version }} - Check Linting - ${{ matrix.os }}
+    name: Python ${{ matrix.python_version }} - Check Linting and Formatting - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python_version: ["3.9", "3.10", "3.11", "3.12"]
     steps:
     - uses: actions/checkout@v4
     - uses: actions/setup-python@v5
@@ -55,29 +57,10 @@ jobs:
     - name: Install dependencies
       run: |
         python3 -m pip install --upgrade pip
-        python3 -m pip install -e '.[dev]'
+        python3 -m pip install -e '.[lint]'
 
     - name: Run lint check
-      run: python -m ruff check .
-
-  python-format-check:
-    if: ${{ always() }} # Always run even if a matrix candidate fails
-    name: Python ${{ matrix.python_version }} - Check formatting - ${{ matrix.os }}
-    runs-on: ${{ matrix.os }}
-    strategy:
-      matrix:
-        os: [ubuntu-latest]
-        python_version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
-    steps:
-    - uses: actions/checkout@v4
-    - uses: actions/setup-python@v5
-      with:
-        python-version: ${{ matrix.python_version }}
-        architecture: x64
-    - name: Install dependencies
-      run: |
-        python3 -m pip install --upgrade pip
-        python3 -m pip install -e '.[dev]'
+      run: python3 -m ruff check .
 
     - name: Run format check
-      run: python -m black .
+      run: python3 -m ruff format . --check

.github/workflows/release.yml

@@ -7,7 +7,7 @@ on:
   workflow_dispatch:
 
 env:
-  DEFAULT_PYTHON: 3.8
+  DEFAULT_PYTHON: 3.9
 
 jobs:
   release-pypi:
@@ -22,9 +22,9 @@ jobs:
         with:
           python-version: ${{ env.DEFAULT_PYTHON }}
       - name: Install requirements
-        run: python -m pip install build twine
+        run: python3 -m pip install build twine
       - name: Build distributions
-        run: python -m build
+        run: python3 -m build
       - name: Upload to PyPI
         env:
           TWINE_REPOSITORY: pypi

.pre-commit-config.yaml

@@ -20,7 +20,5 @@ repos:
     hooks:
     - id: ruff
       args: ["--fix"]
-  - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 24.3.0
-    hooks:
-    - id: black
+      # Run the formatter.
+      - id: ruff-format

.vscode/launch.json

@@ -12,6 +12,16 @@
             "purpose": ["debug-test"],
             "console": "integratedTerminal",
             "justMyCode": false
+        },
+        {
+            "name": "Serve MkDocs",
+            "type": "debugpy",
+            "request": "launch",
+            "python": "${workspaceFolder}/.venv/bin/python",
+            "cwd": "${workspaceFolder}",
+            "module": "mkdocs",
+            "args": ["serve", "-f", "docs/mkdocs.yml"],
+            "console": "integratedTerminal",
         }
     ]
 }

CONTRIBUTING.md

@@ -8,10 +8,10 @@ This repository is open for everyone to contribute and is maintained by [John Az
 
 ## Develop Locally
 
-To run the the package locally (Lean more: [here](https://python-packaging-tutorial.readthedocs.io/2018/setup_py.html#under-development)):
+To run the the package locally (Lean more: [here](https://packaging.python.org/en/latest/guides/distributing-packages-using-setuptools/#working-in-development-mode)):
 
 ```shell
-python setup.py develop
+pip install -e .
 ```
 
 Any changes you do will take effect immediately.

docs/source/index.md

@@ -6,7 +6,7 @@ Markdown link validation reporting tool. It provides a couple of functions to va
 
 You will need the following prerequisites in order to use this library:
 
-- Python >= 3.8
+- Python >= 3.9
 - [requests](https://pypi.org/project/requests/)
 
 ## Installation

pyproject.toml

@@ -11,7 +11,7 @@ maintainers = [{ name = "John Aziz", email = "[email protected]" }]
 license = {file = "LICENSE"}
 readme = "README.md"
 
-requires-python = ">=3.8"
+requires-python = ">=3.9"
 dependencies = [
     "requests",
     "types-requests",
@@ -21,7 +21,6 @@ classifiers = [
     "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",
@@ -40,26 +39,29 @@ Releases = "https://github.com/john0isaac/markdown-checker/releases"
 
 [project.optional-dependencies]
 dev = [
-    "pytest",
-    "pytest-cov",
     "pre-commit",
-    "ruff",
-    "black",
-    "mypy",
+    "mypy"
+]
+lint = [
+    "ruff"
+]
+test = [
+    "pytest",
+    "pytest-cov"
+]
+docs = [
+    "mkdocs",
+    "mkdocs-material",
+    "mkdocstrings[python]",
+    "pymdown-extensions"
 ]
 
 [tool.ruff]
+lint.select = ["E", "F", "I", "UP"]
 line-length = 120
-target-version = "py38"
+target-version = "py39"
 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"

src/markdown_checker/check_markdown.py

@@ -3,8 +3,6 @@
 following some Guidelines
 """
 
-from typing import List
-
 from markdown_checker.links.link_operations import (
     check_paths_exists,
     check_url_alive,
@@ -62,7 +60,7 @@ def check_broken_links(file_path: str, link_type: str, check_type: str) -> str:
     return ""
 
 
-def format_links(links: List[str]) -> str:
+def format_links(links: list[str]) -> str:
     """
     Formats a List of links into a string with numbered bullets.
 

src/markdown_checker/links/link_operations.py

@@ -1,9 +1,8 @@
 import os
 import re
-from typing import List
 
 
-def get_links_from_file(file_path: str) -> List[str]:
+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 []
     """
@@ -18,7 +17,7 @@ def get_links_from_file(file_path: str) -> List[str]:
     return all_links
 
 
-def get_urls_from_links(all_links: List[str]) -> List[str]:
+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(
@@ -39,7 +38,7 @@ def get_urls_from_links(all_links: List[str]) -> List[str]:
     return urls
 
 
-def get_paths_from_links(all_links: List[str]) -> List[str]:
+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 ../
     """
@@ -54,7 +53,7 @@ def get_paths_from_links(all_links: List[str]) -> List[str]:
     return paths
 
 
-def check_paths_exists(file_path: str, paths: List[str]) -> List[str]:
+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
     """
@@ -66,7 +65,7 @@ def check_paths_exists(file_path: str, paths: List[str]) -> List[str]:
     return broken_path
 
 
-def check_url_locale(urls: List[str]) -> List[str]:
+def check_url_locale(urls: list[str]) -> list[str]:
     """function checks if a url has country locale
     flags urls that have ==> /en-us/
     """
@@ -81,7 +80,7 @@ def check_url_locale(urls: List[str]) -> List[str]:
     return country_locale
 
 
-def check_url_tracking(urls: List[str]) -> List[str]:
+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=
     """
@@ -94,7 +93,7 @@ def check_url_tracking(urls: List[str]) -> List[str]:
     return tracking_id
 
 
-def check_url_alive(urls: List[str]) -> List[str]:
+def check_url_alive(urls: list[str]) -> list[str]:
     import requests  # type: ignore
 
     broken_urls = []
@@ -112,7 +111,7 @@ def check_url_alive(urls: List[str]) -> List[str]:
 
 
 # DEPRECATED
-def get_urls_from_file(file_path: str) -> List[str]:
+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, encoding="utf-8") as file:
@@ -126,7 +125,7 @@ def get_urls_from_file(file_path: str) -> List[str]:
     return urls
 
 
-def get_paths_from_file(file_path: str) -> List[str]:
+def get_paths_from_file(file_path: str) -> list[str]:
     """function to get relative paths from a file"""
     paths = []
     with open(file_path, encoding="utf-8") as file:

src/markdown_checker/paths/files_paths_reader.py

@@ -9,10 +9,9 @@
 """
 
 import os
-from typing import List, Tuple
 
 
-def get_files_paths_list(root_path: str, extensions: List[str] = []) -> Tuple[List[str], List[str]]:
+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.
@@ -28,8 +27,8 @@ def get_files_paths_list(root_path: str, extensions: List[str] = []) -> Tuple[Li
     if len(extensions) == 0:
         extensions = [".md", ".ipynb"]
 
-    sub_folders: List[str] = []
-    files_paths: List[str] = []
+    sub_folders: list[str] = []
+    files_paths: list[str] = []
 
     for f in os.scandir(root_path):
         if f.is_dir():