Merge branch 'master' of https://github.com/TheAlgorithms/Python

Author: ruppysuppy

.github/stale.yml

@@ -0,0 +1,63 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Number of days of inactivity before an Issue or Pull Request becomes stale
+daysUntilStale: 30
+
+# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
+# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
+daysUntilClose: 7
+
+# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
+onlyLabels: []
+
+# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
+exemptLabels:
+  - "Status: on hold"
+
+# Set to true to ignore issues in a project (defaults to false)
+exemptProjects: false
+
+# Set to true to ignore issues in a milestone (defaults to false)
+exemptMilestones: false
+
+# Set to true to ignore issues with an assignee (defaults to false)
+exemptAssignees: false
+
+# Label to use when marking as stale
+staleLabel: stale
+
+# Limit the number of actions per hour, from 1-30. Default is 30
+limitPerRun: 5
+
+# Comment to post when removing the stale label.
+# unmarkComment: >
+#   Your comment here.
+
+# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
+pulls:
+  # Comment to post when marking as stale. Set to `false` to disable
+  markComment: >
+    This pull request has been automatically marked as stale because it has not had
+    recent activity. It will be closed if no further activity occurs. Thank you
+    for your contributions.
+
+  # Comment to post when closing a stale Pull Request.
+  closeComment: >
+    Please reopen this pull request once you commit the changes requested
+    or make improvements on the code. If this is not the case and you need
+    some help, feel free to seek help from our [Gitter](https://gitter.im/TheAlgorithms)
+    or ping one of the reviewers. Thank you for your contributions!
+
+issues:
+  # Comment to post when marking as stale. Set to `false` to disable
+  markComment: >
+    This issue has been automatically marked as stale because it has not had
+    recent activity. It will be closed if no further activity occurs. Thank you
+    for your contributions.
+
+  # Comment to post when closing a stale Issue.
+  closeComment: >
+    Please reopen this issue once you add more information and updates here.
+    If this is not the case and you need some help, feel free to seek help
+    from our [Gitter](https://gitter.im/TheAlgorithms) or ping one of the
+    reviewers. Thank you for your contributions!

.github/workflows/auto_close_empty_issues.yml

@@ -0,0 +1,27 @@
+name: "build"
+
+on:
+  pull_request:
+  schedule:
+    - cron: "0 0 * * *" # Run everyday
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('requirements.txt') }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip setuptools six wheel
+          python -m pip install pytest-cov -r requirements.txt
+      - name: Run tests
+        run: pytest --doctest-modules --ignore=project_euler/ --ignore=scripts/ --cov-report=term-missing:skip-covered --cov=. .
+      - if: ${{ success() }}
+        run: scripts/build_directory_md.py 2>&1 | tee DIRECTORY.md

.github/workflows/build.yml

@@ -7,6 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        with:
+          path: |
+            ~/.cache/pre-commit
+            ~/.cache/pip
+          key: ${{ runner.os }}-pre-commit-${{ hashFiles('.pre-commit-config.yaml') }}
       - uses: actions/setup-python@v2
       - name: Install pre-commit
         run: |

.github/workflows/pre-commit.yml

@@ -1,12 +1,14 @@
 on:
   pull_request:
-    # only check if a file is changed within the project_euler directory and related files
+    # Run only if a file is changed within the project_euler directory and related files
     paths:
-      - 'project_euler/**'
-      - '.github/workflows/project_euler.yml'
-      - 'scripts/validate_solutions.py'
+      - "project_euler/**"
+      - ".github/workflows/project_euler.yml"
+      - "scripts/validate_solutions.py"
+  schedule:
+    - cron: "0 0 * * *" # Run everyday
 
-name: 'Project Euler'
+name: "Project Euler"
 
 jobs:
   project-euler:
@@ -24,8 +26,10 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
-      - name: Install pytest
+      - name: Install pytest and requests
         run: |
           python -m pip install --upgrade pip
-          python -m pip install --upgrade pytest
+          python -m pip install --upgrade pytest requests
       - run: pytest scripts/validate_solutions.py
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/project_euler.yml

@@ -42,7 +42,7 @@ repos:
     hooks:
       - id: codespell
         args:
-          - --ignore-words-list=ans,fo,followings,hist,iff,secant,som,tim
+          - --ignore-words-list=ans,fo,followings,hist,iff,mater,secant,som,tim
           - --skip="./.*,./other/dictionary.txt,./other/words,./project_euler/problem_022/p022_names.txt"
           - --quiet-level=2
         exclude: |

.github/workflows/stale.yml

@@ -49,6 +49,19 @@ Algorithms should:
 
 Algorithms in this repo should not be how-to examples for existing Python packages.  Instead, they should perform internal calculations or manipulations to convert input values into different output values.  Those calculations or manipulations can use data types, classes, or functions of existing Python packages but each algorithm in this repo should add unique value.
 
+#### Pre-commit plugin
+Use [pre-commit](https://pre-commit.com/#installation) to automatically format your code to match our coding style:
+
+```bash
+python3 -m pip install pre-commit  # required only once
+pre-commit install
+```
+That's it! The plugin will run every time you commit any changes. If there are any errors found during the run, fix them and commit those changes. You can even run the plugin manually on all files:
+
+```bash
+pre-commit run --all-files --show-diff-on-failure
+```
+
 #### Coding Style
 
 We want your work to be readable by others; therefore, we encourage you to note the following:
@@ -64,14 +77,14 @@ We want your work to be readable by others; therefore, we encourage you to note
 - Please consider running [__psf/black__](https://github.com/python/black) on your Python file(s) before submitting your pull request.  This is not yet a requirement but it does make your code more readable and automatically aligns it with much of [PEP 8](https://www.python.org/dev/peps/pep-0008/). There are other code formatters (autopep8, yapf) but the __black__ formatter is now hosted by the Python Software Foundation. To use it,
 
   ```bash
-  pip3 install black  # only required the first time
+  python3 -m pip install black  # only required the first time
   black .
   ```
 
 - All submissions will need to pass the test __flake8 . --ignore=E203,W503 --max-line-length=88__ before they will be accepted so if possible, try this test locally on your Python file(s) before submitting your pull request.
 
   ```bash
-  pip3 install flake8  # only required the first time
+  python3 -m pip install flake8  # only required the first time
   flake8 . --ignore=E203,W503  --max-line-length=88 --show-source
   ```