Merge pull request #575 from iKostanOrg/master

Merge from master
iKostanOrg · Dec 25, 2024 · c5f9151 · c5f9151
2 parents 53ec721 + 2f84a83
commit c5f9151
Show file tree

Hide file tree

Showing 268 changed files with 1,752 additions and 905 deletions.
diff --git a/.github/workflows/lint_test_build_pipeline.yml b/.github/workflows/lint_test_build_pipeline.yml
@@ -22,6 +22,9 @@ jobs:
   yamllint:
     name: YAML Lint
     uses: iKostanOrg/codewars/.github/workflows/yamllint.yml@master
+  pydocstyle:
+    name: PyDocStyle Lint
+    uses: iKostanOrg/codewars/.github/workflows/pydocstyle.yml@master
   pytest:
     name: Unitest with pytest
     needs:
@@ -30,6 +33,7 @@ jobs:
       - markdown
       - mypy
       - yamllint
+      - pydocstyle
     uses: iKostanOrg/codewars/.github/workflows/pytest.yml@master
   codecov:
     name: Codecov GitHub Action

diff --git a/.github/workflows/markdown_lint.yml b/.github/workflows/markdown_lint.yml
@@ -1,5 +1,5 @@
 ---
-name: 'Markdown Lint'
+name: Markdown Lint
 
 on:   # yamllint disable-line rule:truthy
   push:

diff --git a/.github/workflows/pydocstyle.yml b/.github/workflows/pydocstyle.yml
@@ -0,0 +1,66 @@
+---
+name: pydocstyle
+
+on:   # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - 'utils'
+      - 'none'
+  workflow_call:
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.x"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        # This is the version of the action for setting up Python,
+        # not the Python version.
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # You can test your matrix by printing the current Python version
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install -r requirements.txt
+          pip install pydocstyle
+          pip install types-requests
+      - name: Check to make sure that the module is in your Python path
+        run: |
+          echo $PYTHONPATH
+      - name: Check pydocstyle version
+        run: |
+          pydocstyle --version
+      # Pydocstyle testing (Guide)
+      # https://www.pydocstyle.org/en/stable/usage.html#cli-usage
+      - name: Doc style checking with pydocstyle for kyu_2
+        run: |
+          pydocstyle --verbose --explain --count kyu_2
+      - name: Doc style checking with pydocstyle for kyu_3
+        run: |
+          pydocstyle --verbose --explain --count kyu_3
+      - name: Doc style checking with pydocstyle for kyu_4
+        run: |
+          pydocstyle --verbose --explain --count kyu_4
+      - name: Doc style checking with pydocstyle for kyu_5
+        run: |
+          pydocstyle --verbose --explain --count kyu_5
+      - name: Doc style checking with pydocstyle for kyu_6
+        run: |
+          pydocstyle --verbose --explain --count kyu_6
+      - name: Doc style checking with pydocstyle for kyu_7
+        run: |
+          pydocstyle --verbose --explain --count kyu_7
+      - name: Doc style checking with pydocstyle for kyu_8
+        run: |
+          pydocstyle --verbose --explain --count kyu_8
diff --git a/.github/workflows/pydocstyle_kyu8.yml b/.github/workflows/pydocstyle_kyu8.yml
@@ -0,0 +1,46 @@
+---
+name: pydocstyle for kyu8
+
+on:   # yamllint disable-line rule:truthy
+  push:
+    branches:
+      - 'kyu8'
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.x"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        # This is the version of the action for setting up Python,
+        # not the Python version.
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      # You can test your matrix by printing the current Python version
+      - name: Display Python version
+        run: python -c "import sys; print(sys.version)"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools wheel
+          pip install -r requirements.txt
+          pip install pydocstyle
+          pip install types-requests
+      - name: Check to make sure that the module is in your Python path
+        run: |
+          echo $PYTHONPATH
+      - name: Check pydocstyle version
+        run: |
+          pydocstyle --version
+      - name: Doc style checking with pydocstyle
+        # Pydocstyle testing (Guide)
+        # https://www.pydocstyle.org/en/stable/usage.html#cli-usage
+        run: |
+          pydocstyle --verbose --explain --count kyu_8
diff --git a/README.md b/README.md
@@ -354,13 +354,11 @@ the environment for every build, see comment from Grimmy below).
 <details>
 <summary>ERROR: The term 'make' is not recognized as the name of a cmdlet</summary>
 
-'make' is not recognized as an internal or external command.
-
 The error "'make' is not recognized as an internal or external command, operable program or
 batch file" occurs when we run the make command on Windows without having make installed.
 To solve the error, install make using Chocolatey.
 
-```
+```bash
 make clean
 make : The term 'make' is not recognized as the name of a cmdlet, function, script file, or operable program. Check the spelling of the name, or if a path 
 was included, verify that the path is correct and try again.
@@ -378,18 +376,18 @@ To install Chocolatey:
 
 1. Open PowerShell as an administrator.
 2. Run the following command:
-    ```
+    ```bash
     Set-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))
     ```
 3. Wait for the command to complete.
 4. Type choco to make sure Chocolatey is installed:
-    ```
+    ```bash
     PS C:\WINDOWS\system32> choco
     Chocolatey v2.4.1
     Please run 'choco -?' or 'choco <command> -?' for help menu.
     ```
 5. Now that you have Chocolatey installed, run the following command to install make:
-    ```
+    ```bash
     PS C:\WINDOWS\system32> choco install make -y
     Chocolatey v2.4.1
     Installing the following packages:

diff --git a/docs/index.rst b/docs/index.rst
@@ -16,8 +16,8 @@ Welcome to Python3 solutions for codewars problems documentation!
    kyu_4/kyu_4
    kyu_5/kyu_5
    kyu_6/kyu_6
-   kyu_7
-   kyu_8
+   kyu_7/kyu_7
+   kyu_8/kyu_8
    utils
 
 Indices and tables

diff --git a/docs/kyu_7.coloured_triangles.readme.rst b/docs/kyu_7.coloured_triangles.readme.rst
diff --git a/docs/kyu_7.rst b/docs/kyu_7.rst
diff --git a/docs/kyu_7/kyu_7.always_perfect.module.rst b/docs/kyu_7/kyu_7.always_perfect.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.always\_perfect.module package
+=====================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.always_perfect.readme
+   kyu_7.always_perfect
diff --git a/docs/kyu_7/kyu_7.always_perfect.readme.rst b/docs/kyu_7/kyu_7.always_perfect.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/always_perfect/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.always_perfect.rst → docs/kyu_7/kyu_7.always_perfect.rst b/docs/kyu_7.always_perfect.rst → docs/kyu_7/kyu_7.always_perfect.rst
diff --git a/docs/kyu_7/kyu_7.basic_math_add_or_subtract.module.rst b/docs/kyu_7/kyu_7.basic_math_add_or_subtract.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.basic\_math\_add\_or\_subtract.module package
+====================================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.basic_math_add_or_subtract.readme
+   kyu_7.basic_math_add_or_subtract
diff --git a/docs/kyu_7/kyu_7.basic_math_add_or_subtract.readme.rst b/docs/kyu_7/kyu_7.basic_math_add_or_subtract.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/basic_math_add_or_subtract/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.basic_math_add_or_subtract.rst → ...yu_7/kyu_7.basic_math_add_or_subtract.rst b/docs/kyu_7.basic_math_add_or_subtract.rst → ...yu_7/kyu_7.basic_math_add_or_subtract.rst
diff --git a/docs/kyu_7/kyu_7.beginner_series_sum_of_numbers.module.rst b/docs/kyu_7/kyu_7.beginner_series_sum_of_numbers.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.beginner_series_sum_of_numbers.module package
+====================================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.beginner_series_sum_of_numbers.readme
+   kyu_7.beginner_series_sum_of_numbers
diff --git a/docs/kyu_7/kyu_7.beginner_series_sum_of_numbers.readme.rst b/docs/kyu_7/kyu_7.beginner_series_sum_of_numbers.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/beginner_series_sum_of_numbers/README.md
+   :parser: myst_parser.sphinx_
diff --git a/.../kyu_7.beginner_series_sum_of_numbers.rst → .../kyu_7.beginner_series_sum_of_numbers.rst b/.../kyu_7.beginner_series_sum_of_numbers.rst → .../kyu_7.beginner_series_sum_of_numbers.rst
diff --git a/docs/kyu_7.coloured_triangles.module.rst → ...kyu_7/kyu_7.coloured_triangles.module.rst b/docs/kyu_7.coloured_triangles.module.rst → ...kyu_7/kyu_7.coloured_triangles.module.rst
diff --git a/docs/kyu_7/kyu_7.coloured_triangles.readme.rst b/docs/kyu_7/kyu_7.coloured_triangles.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/coloured_triangles/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.coloured_triangles.rst → docs/kyu_7/kyu_7.coloured_triangles.rst b/docs/kyu_7.coloured_triangles.rst → docs/kyu_7/kyu_7.coloured_triangles.rst
diff --git a/docs/kyu_7/kyu_7.disemvowel_trolls.module.rst b/docs/kyu_7/kyu_7.disemvowel_trolls.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.disemvowel_trolls.module package
+=======================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.disemvowel_trolls.readme
+   kyu_7.disemvowel_trolls
diff --git a/docs/kyu_7/kyu_7.disemvowel_trolls.readme.rst b/docs/kyu_7/kyu_7.disemvowel_trolls.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/disemvowel_trolls/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.disemvowel_trolls.rst → docs/kyu_7/kyu_7.disemvowel_trolls.rst b/docs/kyu_7.disemvowel_trolls.rst → docs/kyu_7/kyu_7.disemvowel_trolls.rst
diff --git a/docs/kyu_7/kyu_7.easy_line.module.rst b/docs/kyu_7/kyu_7.easy_line.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.easy\_line.module package
+================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.easy_line.readme
+   kyu_7.easy_line
diff --git a/docs/kyu_7/kyu_7.easy_line.readme.rst b/docs/kyu_7/kyu_7.easy_line.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/easy_line/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.easy_line.rst → docs/kyu_7/kyu_7.easy_line.rst b/docs/kyu_7.easy_line.rst → docs/kyu_7/kyu_7.easy_line.rst
diff --git a/docs/kyu_7/kyu_7.factorial.module.rst b/docs/kyu_7/kyu_7.factorial.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.factorial.module package
+===============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.factorial.readme
+   kyu_7.factorial
diff --git a/docs/kyu_7/kyu_7.factorial.readme.rst b/docs/kyu_7/kyu_7.factorial.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/factorial/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.factorial.rst → docs/kyu_7/kyu_7.factorial.rst b/docs/kyu_7.factorial.rst → docs/kyu_7/kyu_7.factorial.rst
diff --git a/docs/kyu_7/kyu_7.fill_the_hard_disk_drive.module.rst b/docs/kyu_7/kyu_7.fill_the_hard_disk_drive.module.rst
@@ -0,0 +1,11 @@
+kyu\_7.fill_the_hard_disk_drive.module package
+==============================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   kyu_7.fill_the_hard_disk_drive.readme
+   kyu_7.fill_the_hard_disk_drive
diff --git a/docs/kyu_7/kyu_7.fill_the_hard_disk_drive.readme.rst b/docs/kyu_7/kyu_7.fill_the_hard_disk_drive.readme.rst
@@ -0,0 +1,5 @@
+README
+======
+
+.. include:: ../../kyu_7/fill_the_hard_disk_drive/README.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/kyu_7.fill_the_hard_disk_drive.rst → .../kyu_7/kyu_7.fill_the_hard_disk_drive.rst b/docs/kyu_7.fill_the_hard_disk_drive.rst → .../kyu_7/kyu_7.fill_the_hard_disk_drive.rst