Merge v3.0.0 to main branch

Author: efa2d19

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,48 @@
+### Title of Pull Request
+
+Fixes #[Issue Number]
+
+#### Description
+
+_Briefly describe the changes in this pull request._
+
+- [Summary of major changes]
+- [Summary of minor changes]
+- [Any other relevant information]
+
+#### Type of Change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+#### How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.
+Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+
+- [ ] Test A
+- [ ] Test B
+
+#### Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented on my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have used Conventional Commits for my commit messages
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
+- [ ] Any dependent changes have been merged and published in downstream modules
+
+#### Screenshots (if applicable)
+
+_Attach screenshots or screen recordings of the changes, if any._
+
+#### Additional Context
+
+_Add any other context or information about the pull request here._

.github/dependabot.yml

@@ -16,4 +16,3 @@ updates:
     commit-message:
       prefix: "poetry"
     target-branch: "develop"
-    

.github/workflows/codeql.yml

@@ -2,10 +2,15 @@ name: CodeQL
 
 on:
   push:
-    branches: [ 'main', 'develop' ]
+    branches:
+      - main
+      - develop
+
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ 'main', 'develop' ]
+    branches:
+      - main
+      - develop
 
 jobs:
   analyze:
@@ -20,8 +25,6 @@ jobs:
       fail-fast: false
       matrix:
         language: [ 'python' ]
-        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
-        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
 
     steps:
     - name: Checkout repository
@@ -32,12 +35,6 @@ jobs:
       uses: github/codeql-action/init@v2
       with:
         languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        
-        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
-        # queries: security-extended,security-and-quality
 
     - name: Perform CodeQL Analysis
       uses: github/codeql-action/analyze@v2

.github/workflows/greetings.yml

@@ -1,6 +1,6 @@
 name: Greetings
 
-on: [pull_request_target, issues]
+on: [ pull_request, issues ]
 
 jobs:
   greeting:

.github/workflows/tox.yml

@@ -2,27 +2,32 @@ name: Tests
 
 on:
   push:
-    branches: [ 'main', 'develop' ]
+    branches:
+      - main
+      - develop
+
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ 'main', 'develop' ]
+    branches:
+      - main
+      - develop
 
 jobs:
   tests:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10']
+        python-version: [ '3.10', '3.11' ]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
       - name: Set up Python V${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
+      - name: Install tox-gh-actions
         run: |
           python -m pip install --upgrade pip
           pip install tox tox-gh-actions
-      - name: Test w/ Tox
-        run: tox
+      - name: Tests with Tox
+        run: tox

.gitignore

@@ -36,3 +36,9 @@ mac_cleanup/modules.toml
 
 # tox
 .tox/*
+
+# ruff
+.ruff_cache/
+
+# macOS stuff
+.DS_Store

.pre-commit-config.yaml

@@ -0,0 +1,55 @@
+default_stages:
+  - push
+
+repos:
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v2.42.1
+    hooks:
+      - id: commitizen
+        name: Check Convenient Commits
+        stages: [ commit-msg ]
+
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+        name: Run black
+        types: [ python ]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+        name: Run isort
+        types: [ python ]
+
+  - repo: https://github.com/PyCQA/docformatter
+    rev: v1.5.1
+    hooks:
+      - id: docformatter
+        name: Run docformatter
+        types: [ python ]
+        args: [ --config=./pyproject.toml]
+
+  - repo: local
+    hooks:
+      - id: pytest
+        name: Run pytest
+        language: system
+        pass_filenames: false
+        types: [ python ]
+        entry: poetry run pytest
+
+      - id: pyright
+        name: Run pyright
+        language: system
+        pass_filenames: false
+        types: [ python ]
+        entry: poetry run pyright
+
+      - id: ruff
+        name: Run ruff
+        language: system
+        pass_filenames: false
+        types: [ python ]
+        entry: poetry run ruff check .

CODE_OF_CONDUCT.md

@@ -2,7 +2,7 @@
 
 # TL;DR
 
-> ### Be nice to each other or you'll face the consequences
+> ### Be nice to each other, or you'll face the consequences
 
 ## Our Pledge
 
@@ -129,4 +129,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
 
 For answers to common questions about this code of conduct, see the FAQ at
 https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -7,11 +7,14 @@ Read repo's [Code of Conduct](./CODE_OF_CONDUCT.md) to keep community respectabl
 ## TL;DR
 
 > #### 1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) the repo
-> #### 2. [Checkout](https://www.atlassian.com/git/tutorials/using-branches/git-checkout) from 'develop' branch
-> #### 3. [Commit](https://www.atlassian.com/git/tutorials/saving-changes/git-commit) your changes
-> #### 4. [Push the changes](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) to your fork 
-> #### 4. [Open PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to 'develop' branch
-> #### Congrats :tada::sparkles:. CYA in your PR's comments 😉
+> #### 2. [Checkout](https://www.atlassian.com/git/tutorials/using-branches/git-checkout) from `develop` branch
+> #### 3. Install dependencies: `pip install poetry && poetry install`
+> #### 3. Setup `pre-commit` hooks: `pre-commit install --hook-type pre-commit --hook-type pre-push`
+> #### 4. [Commit](https://www.atlassian.com/git/tutorials/saving-changes/git-commit) your changes with [Conventional Commits](https://www.conventionalcommits.org)
+> #### 5. Run tests: `poetry run tox`
+> #### 6. [Push the changes](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push) to your fork 
+> #### 7. [Open PR](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to 'develop' branch
+> #### Congrats :tada::sparkles:. CYA in your PRs 😉
 
 
 ## New contributor guide
@@ -42,10 +45,20 @@ If you find an issue to work on, just post a comment on the issue's page and you
 
 ### Make Changes
 
-1. Fork the repository.
-  - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
-
-2. Create a working branch out of 'develop' and start with your changes!
+1. [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
+2. Create a working branch out of 'develop' and start with your changes
+3. Install dependencies
+    ```bash
+   pip install poetry && poetry install
+   ```
+4. Setup pre-commit hooks
+    ```bash
+   pre-commit install --hook-type pre-commit --hook-type pre-push
+    ```
+5. Run tests before pushing
+    ```bash
+   poetry run tox
+    ```
 
 ### Commit your update
 
@@ -68,4 +81,4 @@ Once you submit your PR, someone of collaborators will come and see your PR.
 
 Congratulations :tada::sparkles:
 
-Once your PR is merged, your contributions will be publicly visible on the [mac-cleanup-py](https://github.com/mac-cleanup/mac-cleanup-py).
+Once your PR is merged, your contributions will be publicly visible on the [mac-cleanup-py](https://github.com/mac-cleanup/mac-cleanup-py).