Release of V2

.dockerignore

@@ -1,7 +1,7 @@
 __pycache__/
 .pytest_cache/
-config/config.conf
 test*.py
 ToDo
 .vscode
-snip*.py
+.notebooks
+logs/*

.github/workflows/build.yml

@@ -4,14 +4,14 @@ on:
   push:
     branches:
       - '*'
-    paths-ignore:
-      - '**/*.md'
+    paths:
+      - 'src/**'
   pull_request:
     branches:
-      - '*' 
-    paths-ignore:
-      - '**/*.md'
-  workflow_dispatch: 
+      - '*'
+    paths:
+      - 'src/**'
+  workflow_dispatch:
   create:
     branches:
       - '*'

.gitignore

@@ -1,7 +1,13 @@
 __pycache__/
 .pytest_cache/
 config/config.conf
+config/config.yaml
 ToDo 
 snip*.py
 venv
-testMagnets.txt
+.venv
+temp
+.notebooks
+**/old/
+logs/*
+.idea/*

.pre-commit-config.yaml

@@ -1,10 +1,34 @@
 repos:
-  - repo: local
-    hooks:
-      - id: black
-        name: black
-        entry: venv/bin/black
-        language: system
-        types: [python]
+- repo: local
+  hooks:
+    - id: black
+      name: black
+      entry: |
+        bash -c 'BIN=".venv/bin/black"; 
+        [ ! -f "$BIN" ] && BIN=".venv/Scripts/black"; 
+        $BIN .'
+      language: system
 
+    - id: autoflake
+      name: autoflake
+      entry: |
+        bash -c 'BIN=".venv/bin/autoflake"; 
+        [ ! -f "$BIN" ] && BIN=".venv/Scripts/autoflake"; 
+        $BIN --in-place --remove-all-unused-imports --remove-unused-variables --recursive --exclude .venv .'
+      language: system
 
+    - id: isort
+      name: isort
+      entry: |
+        bash -c 'BIN=".venv/bin/isort"; 
+        [ ! -f "$BIN" ] && BIN=".venv/Scripts/isort"; 
+        $BIN -rc .'
+      language: system
+
+    - id: pylint
+      name: pylint
+      entry: |
+        bash -c 'BIN=".venv/bin/pylint"; 
+        [ ! -f "$BIN" ] && BIN=".venv/Scripts/pylint"; 
+        $BIN .'
+      language: system

.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    "recommendations": [
+        "ms-python.python",
+        "ms-python.pylint",
+        "ms-python.black-formatter",
+        "ms-python.isort",
+        "ms-toolsai.jupyter"
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+      {
+        "name": "Python: Main from Root",
+        "type": "python",
+        "request": "launch",
+        "program": "${workspaceFolder}/main.py",
+        "cwd": "${workspaceFolder}",
+        "env": {
+          "PYTHONPATH": "${workspaceFolder}"
+        }
+      }
+    ]
+  }

.vscode/settings.json

@@ -1,4 +1,10 @@
 {
     "editor.formatOnSave": true,
-    "editor.defaultFormatter": "ms-python.black-formatter"
+    "editor.defaultFormatter": "ms-python.black-formatter",
+    "python.terminal.activateEnvironment": true,
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
 }

CONTRIBUTING.md

@@ -2,9 +2,9 @@
 
 ## Table of contents
 - [Overview](#overview)
-- [Feature Requests](#feature--requests)
-- [Bug Reports](#bug--reports)
-- [Code Contributions](#code--contributions)
+- [Feature Requests](#feature-requests)
+- [Bug Reports](#bug-reports)
+- [Code Contributions](#code-contributions)
 
 ## Overview
 Thank you for wanting to contribute to this project.
@@ -27,9 +27,9 @@ Please go follow these steps to submit a bug:
 - Create meaningful logs by:
 1) Switch decluttarr to debug mode (setting LOG_LEVEL: DEBUG)
 2) Turn off all remove functions but one where you expect a removal (example: REMOVE_STALLED: True and the rest on False)
-3) Let it run until the supposed remove should be trigged
+3) Let it run until the supposed remove should be triggered
 4) Paste the full logs to a pastebin
-5) Share your settings (docker-compose or config.conf) 
+5) Share your settings (docker-compose or config.yaml) 
 6) Optional: If helpful, share screenshots showing the problem (from your arr-app or qbit) 
 7) Be responsive and provide more details if asked for them, and help testing the bug fix
 
@@ -40,23 +40,23 @@ Code contributions are very welcome - thanks for helping improve this app!
 3) Only commit code that you have written yourself and is not owned by anybody else
 4) Create a PR against the "dev" branch
 5) Be responsive to code review 
-5) Once the code is reviewed and OK, it will be merged to dev branch, which will create the "dev"-docker image
-6) Help testing that the dev image works
-7= Finally, we will then commit the change to the main branch, which will create the "latest"-docker image
+6) Once the code is reviewed and OK, it will be merged to dev branch, which will create the "dev"-docker image
+7) Help testing that the dev image works
+8) Finally, we will then commit the change to the main branch, which will create the "latest"-docker image
 
 You do not need to know about how to create docker images to contribute here.
 To get started:
 1) Create a fork of decluttarr
 2) Clone the git repository from the dev branch to your local machine `git clone -b dev https://github.com/yourName/decluttarr`
-2) Create a virtual python environment (`python3 -m venv venv`)
-3) Activate the virtual environment (`source venv/bin/activate`)
-4) Install python libraries (`pip install -r docker/requirements.txt`)
-5) Adjust the config/config.conf to your needs
-6) Adjust the code in the files as needed
-7) Run the script (`python3 main.py`)
-8) Push your changes to your own git repo and use a descriptive name for the branch name (e.g. add-feature-to-xyz; bugfix-xyz)
-9) Test the dev-image it creates automatically
-10) Create the PR from your repo to ManiMatter/decluttarr (dev branch)
-11) Make sure all checks pass
-12) Squash your commits
-13) Test that the docker image works that was created when you pushed to your fork 
+3) Create a virtual python environment (`python3 -m venv venv`)
+4) Activate the virtual environment (`source venv/bin/activate`)
+5) Install python libraries (`pip install -r docker/requirements.txt`)
+6) Adjust the config/config.conf to your needs
+7) Adjust the code in the files as needed
+8) Run the script (`python3 main.py`)
+9) Push your changes to your own git repo and use a descriptive name for the branch name (e.g. add-feature-to-xyz; bugfix-xyz)
+10) Test the dev-image it creates automatically
+11) Create the PR from your repo to ManiMatter/decluttarr (dev branch)
+12) Make sure all checks pass
+13) Squash your commits
+14) Test that the docker image works that was created when you pushed to your fork