├── .github ├── FUNDING.yml └── workflows │ └── pylint.yml ├── .gitignore ├── .pylintrc ├── LICENSE ├── README.md ├── docs └── images │ └── example.png ├── filter_monitor.py ├── install.sh └── uninstall.sh /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | ko_fi: blankhaus 2 | -------------------------------------------------------------------------------- /.github/workflows/pylint.yml: -------------------------------------------------------------------------------- 1 | name: Pylint 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | strategy: 9 | matrix: 10 | python-version: ["3.8", "3.9", "3.10"] 11 | steps: 12 | - uses: actions/checkout@v4 13 | - name: Set up Python ${{ matrix.python-version }} 14 | uses: actions/setup-python@v3 15 | with: 16 | python-version: ${{ matrix.python-version }} 17 | - name: Install dependencies 18 | run: | 19 | python -m pip install --upgrade pip 20 | pip install pylint 21 | - name: Analysing the code with pylint 22 | run: | 23 | pylint $(git ls-files '*.py') 24 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | share/python-wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | MANIFEST 28 | 29 | # PyInstaller 30 | # Usually these files are written by a python script from a template 31 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 32 | *.manifest 33 | *.spec 34 | 35 | # Installer logs 36 | pip-log.txt 37 | pip-delete-this-directory.txt 38 | 39 | # Unit test / coverage reports 40 | htmlcov/ 41 | .tox/ 42 | .nox/ 43 | .coverage 44 | .coverage.* 45 | .cache 46 | nosetests.xml 47 | coverage.xml 48 | *.cover 49 | *.py,cover 50 | .hypothesis/ 51 | .pytest_cache/ 52 | cover/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | .pybuilder/ 76 | target/ 77 | 78 | # Jupyter Notebook 79 | .ipynb_checkpoints 80 | 81 | # IPython 82 | profile_default/ 83 | ipython_config.py 84 | 85 | # pyenv 86 | # For a library or package, you might want to ignore these files since the code is 87 | # intended to run in multiple environments; otherwise, check them in: 88 | # .python-version 89 | 90 | # pipenv 91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 94 | # install all needed dependencies. 95 | #Pipfile.lock 96 | 97 | # poetry 98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. 99 | # This is especially recommended for binary packages to ensure reproducibility, and is more 100 | # commonly ignored for libraries. 101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control 102 | #poetry.lock 103 | 104 | # pdm 105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. 106 | #pdm.lock 107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it 108 | # in version control. 109 | # https://pdm.fming.dev/#use-with-ide 110 | .pdm.toml 111 | 112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm 113 | __pypackages__/ 114 | 115 | # Celery stuff 116 | celerybeat-schedule 117 | celerybeat.pid 118 | 119 | # SageMath parsed files 120 | *.sage.py 121 | 122 | # Environments 123 | .env 124 | .venv 125 | env/ 126 | venv/ 127 | ENV/ 128 | env.bak/ 129 | venv.bak/ 130 | 131 | # Spyder project settings 132 | .spyderproject 133 | .spyproject 134 | 135 | # Rope project settings 136 | .ropeproject 137 | 138 | # mkdocs documentation 139 | /site 140 | 141 | # mypy 142 | .mypy_cache/ 143 | .dmypy.json 144 | dmypy.json 145 | 146 | # Pyre type checker 147 | .pyre/ 148 | 149 | # pytype static type analyzer 150 | .pytype/ 151 | 152 | # Cython debug symbols 153 | cython_debug/ 154 | 155 | # PyCharm 156 | # JetBrains specific template is maintained in a separate JetBrains.gitignore that can 157 | # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore 158 | # and can be added to the global gitignore or merged into this file. For a more nuclear 159 | # option (not recommended) you can uncomment the following to ignore the entire idea folder. 160 | #.idea/ 161 | -------------------------------------------------------------------------------- /.pylintrc: -------------------------------------------------------------------------------- 1 | [MAIN] 2 | 3 | # Python code to execute, usually for sys.path manipulation such as 4 | # pygtk.require(). 5 | #init-hook= 6 | 7 | # Files or directories to be skipped. They should be base names, not 8 | # paths. 9 | ignore=CVS 10 | 11 | # Add files or directories matching the regex patterns to the ignore-list. The 12 | # regex matches against paths and can be in Posix or Windows format. 13 | ignore-paths= 14 | 15 | # Files or directories matching the regex patterns are skipped. The regex 16 | # matches against base names, not paths. 17 | ignore-patterns=^\.# 18 | 19 | # Pickle collected data for later comparisons. 20 | persistent=yes 21 | 22 | # List of plugins (as comma separated values of python modules names) to load, 23 | # usually to register additional checkers. 24 | load-plugins= 25 | pylint.extensions.check_elif, 26 | pylint.extensions.bad_builtin, 27 | pylint.extensions.docparams, 28 | pylint.extensions.for_any_all, 29 | pylint.extensions.set_membership, 30 | pylint.extensions.code_style, 31 | pylint.extensions.overlapping_exceptions, 32 | pylint.extensions.typing, 33 | pylint.extensions.redefined_variable_type, 34 | pylint.extensions.comparison_placement, 35 | pylint.extensions.broad_try_clause, 36 | pylint.extensions.dict_init_mutate, 37 | pylint.extensions.consider_refactoring_into_while_condition, 38 | 39 | # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the 40 | # number of processors available to use. 41 | jobs=1 42 | 43 | # When enabled, pylint would attempt to guess common misconfiguration and emit 44 | # user-friendly hints instead of false-positive error messages. 45 | suggestion-mode=yes 46 | 47 | # Allow loading of arbitrary C extensions. Extensions are imported into the 48 | # active Python interpreter and may run arbitrary code. 49 | unsafe-load-any-extension=no 50 | 51 | # A comma-separated list of package or module names from where C extensions may 52 | # be loaded. Extensions are loading into the active Python interpreter and may 53 | # run arbitrary code 54 | extension-pkg-allow-list= 55 | 56 | # Minimum supported python version 57 | py-version = 3.9.0 58 | 59 | # Control the amount of potential inferred values when inferring a single 60 | # object. This can help the performance when dealing with large functions or 61 | # complex, nested conditions. 62 | limit-inference-results=100 63 | 64 | # Specify a score threshold under which the program will exit with error. 65 | fail-under=10.0 66 | 67 | # Return non-zero exit code if any of these messages/categories are detected, 68 | # even if score is above --fail-under value. Syntax same as enable. Messages 69 | # specified are enabled, while categories only check already-enabled messages. 70 | fail-on= 71 | 72 | # Clear in-memory caches upon conclusion of linting. Useful if running pylint in 73 | # a server-like mode. 74 | clear-cache-post-run=no 75 | 76 | 77 | [MESSAGES CONTROL] 78 | 79 | # Only show warnings with the listed confidence levels. Leave empty to show 80 | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED 81 | # confidence= 82 | 83 | # Enable the message, report, category or checker with the given id(s). You can 84 | # either give multiple identifier separated by comma (,) or put this option 85 | # multiple time (only on the command line, not in the configuration file where 86 | # it should appear only once). See also the "--disable" option for examples. 87 | enable= 88 | use-symbolic-message-instead, 89 | useless-suppression, 90 | 91 | # Disable the message, report, category or checker with the given id(s). You 92 | # can either give multiple identifiers separated by comma (,) or put this 93 | # option multiple times (only on the command line, not in the configuration 94 | # file where it should appear only once).You can also use "--disable=all" to 95 | # disable everything first and then re-enable specific checks. For example, if 96 | # you want to run only the similarities checker, you can use "--disable=all 97 | # --enable=similarities". If you want to run only the classes checker, but have 98 | # no Warning level messages displayed, use"--disable=all --enable=classes 99 | # --disable=W" 100 | 101 | disable= 102 | attribute-defined-outside-init, 103 | invalid-name, 104 | missing-docstring, 105 | protected-access, 106 | too-few-public-methods, 107 | # handled by black 108 | format, 109 | # We anticipate #3512 where it will become optional 110 | fixme, 111 | consider-using-assignment-expr, 112 | unused-argument, 113 | bare-except, 114 | consider-using-f-string 115 | 116 | 117 | [REPORTS] 118 | 119 | # Set the output format. Available formats are text, parseable, colorized, msvs 120 | # (visual studio) and html. You can also give a reporter class, eg 121 | # mypackage.mymodule.MyReporterClass. 122 | output-format=text 123 | 124 | # Tells whether to display a full report or only the messages 125 | reports=no 126 | 127 | # Python expression which should return a note less than 10 (10 is the highest 128 | # note). You have access to the variables 'fatal', 'error', 'warning', 'refactor', 'convention' 129 | # and 'info', which contain the number of messages in each category, as 130 | # well as 'statement', which is the total number of statements analyzed. This 131 | # score is used by the global evaluation report (RP0004). 132 | evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)) 133 | 134 | # Template used to display messages. This is a python new-style format string 135 | # used to format the message information. See doc for all details 136 | #msg-template= 137 | 138 | # Activate the evaluation score. 139 | score=yes 140 | 141 | 142 | [LOGGING] 143 | 144 | # Logging modules to check that the string format arguments are in logging 145 | # function parameter format 146 | logging-modules=logging 147 | 148 | # The type of string formatting that logging methods do. `old` means using % 149 | # formatting, `new` is for `{}` formatting. 150 | logging-format-style=old 151 | 152 | 153 | [MISCELLANEOUS] 154 | 155 | # List of note tags to take in consideration, separated by a comma. 156 | notes=FIXME,XXX,TODO 157 | 158 | # Regular expression of note tags to take in consideration. 159 | #notes-rgx= 160 | 161 | 162 | [SIMILARITIES] 163 | 164 | # Minimum lines number of a similarity. 165 | min-similarity-lines=6 166 | 167 | # Ignore comments when computing similarities. 168 | ignore-comments=yes 169 | 170 | # Ignore docstrings when computing similarities. 171 | ignore-docstrings=yes 172 | 173 | # Ignore imports when computing similarities. 174 | ignore-imports=yes 175 | 176 | # Signatures are removed from the similarity computation 177 | ignore-signatures=yes 178 | 179 | 180 | [VARIABLES] 181 | 182 | # Tells whether we should check for unused import in __init__ files. 183 | init-import=no 184 | 185 | # List of additional names supposed to be defined in builtins. Remember that 186 | # you should avoid defining new builtins when possible. 187 | additional-builtins= 188 | 189 | # List of strings which can identify a callback function by name. A callback 190 | # name must start or end with one of those strings. 191 | callbacks=cb_,_cb 192 | 193 | # Tells whether unused global variables should be treated as a violation. 194 | allow-global-unused-variables=yes 195 | 196 | # List of names allowed to shadow builtins 197 | allowed-redefined-builtins= 198 | 199 | # List of qualified module names which can have objects that can redefine 200 | # builtins. 201 | redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io 202 | 203 | 204 | [FORMAT] 205 | 206 | # Maximum number of characters on a single line. 207 | max-line-length=100 208 | 209 | # Regexp for a line that is allowed to be longer than the limit. 210 | ignore-long-lines=^\s*(# )??$ 211 | 212 | # Allow the body of an if to be on the same line as the test if there is no 213 | # else. 214 | single-line-if-stmt=no 215 | 216 | # Allow the body of a class to be on the same line as the declaration if body 217 | # contains single statement. 218 | single-line-class-stmt=no 219 | 220 | # Maximum number of lines in a module 221 | max-module-lines=2000 222 | 223 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 224 | # tab). 225 | indent-string=' ' 226 | 227 | # Number of spaces of indent required inside a hanging or continued line. 228 | indent-after-paren=4 229 | 230 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 231 | expected-line-ending-format= 232 | 233 | 234 | [BASIC] 235 | 236 | # Good variable names which should always be accepted, separated by a comma 237 | good-names=i,j,k,ex,Run,_ 238 | 239 | # Good variable names regexes, separated by a comma. If names match any regex, 240 | # they will always be accepted 241 | good-names-rgxs= 242 | 243 | # Bad variable names which should always be refused, separated by a comma 244 | bad-names=foo,bar,baz,toto,tutu,tata 245 | 246 | # Bad variable names regexes, separated by a comma. If names match any regex, 247 | # they will always be refused 248 | bad-names-rgxs= 249 | 250 | # Colon-delimited sets of names that determine each other's naming style when 251 | # the name regexes allow several styles. 252 | name-group= 253 | 254 | # Include a hint for the correct naming format with invalid-name 255 | include-naming-hint=no 256 | 257 | # Naming style matching correct function names. 258 | function-naming-style=snake_case 259 | 260 | # Regular expression matching correct function names 261 | function-rgx=[a-z_][a-z0-9_]{2,30}$ 262 | 263 | # Naming style matching correct variable names. 264 | variable-naming-style=snake_case 265 | 266 | # Regular expression matching correct variable names 267 | variable-rgx=[a-z_][a-z0-9_]{2,30}$ 268 | 269 | # Naming style matching correct constant names. 270 | const-naming-style=UPPER_CASE 271 | 272 | # Regular expression matching correct constant names 273 | const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ 274 | 275 | # Naming style matching correct attribute names. 276 | attr-naming-style=snake_case 277 | 278 | # Regular expression matching correct attribute names 279 | attr-rgx=[a-z_][a-z0-9_]{2,}$ 280 | 281 | # Naming style matching correct argument names. 282 | argument-naming-style=snake_case 283 | 284 | # Regular expression matching correct argument names 285 | argument-rgx=[a-z_][a-z0-9_]{2,30}$ 286 | 287 | # Naming style matching correct class attribute names. 288 | class-attribute-naming-style=any 289 | 290 | # Regular expression matching correct class attribute names 291 | class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ 292 | 293 | # Naming style matching correct class constant names. 294 | class-const-naming-style=UPPER_CASE 295 | 296 | # Regular expression matching correct class constant names. Overrides class- 297 | # const-naming-style. 298 | #class-const-rgx= 299 | 300 | # Naming style matching correct inline iteration names. 301 | inlinevar-naming-style=any 302 | 303 | # Regular expression matching correct inline iteration names 304 | inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ 305 | 306 | # Naming style matching correct class names. 307 | class-naming-style=PascalCase 308 | 309 | # Regular expression matching correct class names 310 | class-rgx=[A-Z_][a-zA-Z0-9]+$ 311 | 312 | 313 | # Naming style matching correct module names. 314 | module-naming-style=snake_case 315 | 316 | # Regular expression matching correct module names 317 | module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ 318 | 319 | 320 | # Naming style matching correct method names. 321 | method-naming-style=snake_case 322 | 323 | # Regular expression matching correct method names 324 | method-rgx=[a-z_][a-z0-9_]{2,}$ 325 | 326 | # Regular expression matching correct type variable names 327 | #typevar-rgx= 328 | 329 | # Regular expression which should only match function or class names that do 330 | # not require a docstring. Use ^(?!__init__$)_ to also check __init__. 331 | no-docstring-rgx=__.*__ 332 | 333 | # Minimum line length for functions/classes that require docstrings, shorter 334 | # ones are exempt. 335 | docstring-min-length=-1 336 | 337 | # List of decorators that define properties, such as abc.abstractproperty. 338 | property-classes=abc.abstractproperty 339 | 340 | 341 | [TYPECHECK] 342 | 343 | # Regex pattern to define which classes are considered mixins if ignore-mixin- 344 | # members is set to 'yes' 345 | mixin-class-rgx=.*MixIn 346 | 347 | # List of module names for which member attributes should not be checked and 348 | # will not be imported (useful for modules/projects where namespaces are 349 | # manipulated during runtime and thus existing member attributes cannot be 350 | # deduced by static analysis). It supports qualified module names, as well 351 | # as Unix pattern matching. 352 | ignored-modules= 353 | 354 | # List of class names for which member attributes should not be checked (useful 355 | # for classes with dynamically set attributes). This supports the use of 356 | # qualified names. 357 | ignored-classes=SQLObject, optparse.Values, thread._local, _thread._local 358 | 359 | # List of members which are set dynamically and missed by pylint inference 360 | # system, and so shouldn't trigger E1101 when accessed. Python regular 361 | # expressions are accepted. 362 | generated-members=REQUEST,acl_users,aq_parent,argparse.Namespace 363 | 364 | # List of decorators that create context managers from functions, such as 365 | # contextlib.contextmanager. 366 | contextmanager-decorators=contextlib.contextmanager 367 | 368 | # Tells whether to warn about missing members when the owner of the attribute 369 | # is inferred to be None. 370 | ignore-none=yes 371 | 372 | # This flag controls whether pylint should warn about no-member and similar 373 | # checks whenever an opaque object is returned when inferring. The inference 374 | # can return multiple potential results while evaluating a Python object, but 375 | # some branches might not be evaluated, which results in partial inference. In 376 | # that case, it might be useful to still emit no-member and other checks for 377 | # the rest of the inferred objects. 378 | ignore-on-opaque-inference=yes 379 | 380 | # Show a hint with possible names when a member name was not found. The aspect 381 | # of finding the hint is based on edit distance. 382 | missing-member-hint=yes 383 | 384 | # The minimum edit distance a name should have in order to be considered a 385 | # similar match for a missing member name. 386 | missing-member-hint-distance=1 387 | 388 | # The total number of similar names that should be taken in consideration when 389 | # showing a hint for a missing member. 390 | missing-member-max-choices=1 391 | 392 | [SPELLING] 393 | 394 | # Spelling dictionary name. Available dictionaries: none. To make it working 395 | # install python-enchant package. 396 | spelling-dict= 397 | 398 | # List of comma separated words that should not be checked. 399 | spelling-ignore-words= 400 | 401 | # List of comma separated words that should be considered directives if they 402 | # appear and the beginning of a comment and should not be checked. 403 | spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:,pragma:,# noinspection 404 | 405 | # A path to a file that contains private dictionary; one word per line. 406 | spelling-private-dict-file=.pyenchant_pylint_custom_dict.txt 407 | 408 | # Tells whether to store unknown words to indicated private dictionary in 409 | # --spelling-private-dict-file option instead of raising a message. 410 | spelling-store-unknown-words=no 411 | 412 | # Limits count of emitted suggestions for spelling mistakes. 413 | max-spelling-suggestions=2 414 | 415 | 416 | [DESIGN] 417 | 418 | # Maximum number of arguments for function / method 419 | max-args = 9 420 | 421 | # Maximum number of locals for function / method body 422 | max-locals = 19 423 | 424 | # Maximum number of return / yield for function / method body 425 | max-returns=11 426 | 427 | # Maximum number of branch for function / method body 428 | max-branches = 20 429 | 430 | # Maximum number of statements in function / method body 431 | max-statements = 50 432 | 433 | # Maximum number of attributes for a class (see R0902). 434 | max-attributes=30 435 | 436 | # Maximum number of statements in a try-block 437 | max-try-statement = 8 438 | 439 | # Maximum number of positional arguments (see R0917). 440 | # max-positional-arguments = 12 441 | 442 | [CLASSES] 443 | 444 | # List of method names used to declare (i.e. assign) instance attributes. 445 | defining-attr-methods=__init__,__new__,setUp,__post_init__ 446 | 447 | # List of valid names for the first argument in a class method. 448 | valid-classmethod-first-arg=cls 449 | 450 | # List of valid names for the first argument in a metaclass class method. 451 | valid-metaclass-classmethod-first-arg=mcs 452 | 453 | # List of member names, which should be excluded from the protected access 454 | # warning. 455 | exclude-protected=_asdict,_fields,_replace,_source,_make 456 | 457 | # Warn about protected attribute access inside special methods 458 | check-protected-access-in-special-methods=no 459 | 460 | [IMPORTS] 461 | 462 | # List of modules that can be imported at any level, not just the top level 463 | # one. 464 | allow-any-import-level= 465 | 466 | # Allow wildcard imports from modules that define __all__. 467 | allow-wildcard-with-all=no 468 | 469 | # Allow explicit reexports by alias from a package __init__. 470 | allow-reexport-from-package=no 471 | 472 | # Analyse import fallback blocks. This can be used to support both Python 2 and 473 | # 3 compatible code, which means that the block might have code that exists 474 | # only in one or another interpreter, leading to false positives when analysed. 475 | analyse-fallback-blocks=no 476 | 477 | # Deprecated modules which should not be used, separated by a comma 478 | deprecated-modules=regsub,TERMIOS,Bastion,rexec 479 | 480 | # Create a graph of every (i.e. internal and external) dependencies in the 481 | # given file (report RP0402 must not be disabled) 482 | import-graph= 483 | 484 | # Create a graph of external dependencies in the given file (report RP0402 must 485 | # not be disabled) 486 | ext-import-graph= 487 | 488 | # Create a graph of internal dependencies in the given file (report RP0402 must 489 | # not be disabled) 490 | int-import-graph= 491 | 492 | # Force import order to recognize a module as part of the standard 493 | # compatibility libraries. 494 | known-standard-library=_string 495 | 496 | # Force import order to recognize a module as part of a third party library. 497 | known-third-party=enchant 498 | 499 | # Couples of modules and preferred modules, separated by a comma. 500 | preferred-modules= 501 | 502 | 503 | [EXCEPTIONS] 504 | 505 | # Exceptions that will emit a warning when being caught. Defaults to 506 | # "Exception" 507 | overgeneral-exceptions=builtins.Exception 508 | 509 | 510 | [TYPING] 511 | 512 | # Set to ``no`` if the app / library does **NOT** need to support runtime 513 | # introspection of type annotations. If you use type annotations 514 | # **exclusively** for type checking of an application, you're probably fine. 515 | # For libraries, evaluate if some users what to access the type hints at 516 | # runtime first, e.g., through ``typing.get_type_hints``. Applies to Python 517 | # versions 3.7 - 3.9 518 | runtime-typing = no 519 | 520 | 521 | [DEPRECATED_BUILTINS] 522 | 523 | # List of builtins function names that should not be used, separated by a comma 524 | bad-functions=map,input 525 | 526 | 527 | [REFACTORING] 528 | 529 | # Maximum number of nested blocks for function / method body 530 | max-nested-blocks=5 531 | 532 | # Complete name of functions that never returns. When checking for 533 | # inconsistent-return-statements if a never returning function is called then 534 | # it will be considered as an explicit return statement and no message will be 535 | # printed. 536 | never-returning-functions=sys.exit,argparse.parse_error 537 | 538 | 539 | [STRING] 540 | 541 | # This flag controls whether inconsistent-quotes generates a warning when the 542 | # character used as a quote delimiter is used inconsistently within a module. 543 | check-quote-consistency=no 544 | 545 | # This flag controls whether the implicit-str-concat should generate a warning 546 | # on implicit string concatenation in sequences defined over several lines. 547 | check-str-concat-over-line-jumps=no 548 | 549 | 550 | [CODE_STYLE] 551 | 552 | # Max line length for which to sill emit suggestions. Used to prevent optional 553 | # suggestions which would get split by a code formatter (e.g., black). Will 554 | # default to the setting for ``max-line-length``. 555 | #max-line-length-suggestions= 556 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Filter Monitor 2 | 3 | This Klipper plugin monitors the runtime of air filters (Nevermore, THE FILTER, etc), and triggers notifications and/or executes G-code when threshold conditions, such as max runtime or lifetime hours, are met. These monitoring checks also occur on pre-defined system events and keep track of total fan runtime. 4 | 5 | ![Example](./docs/images/example.png) 6 | 7 | ## Installation 8 | 9 | To install this plugin, first ensure that you already have Klipper, Moonraker, and a WebUI (Mainsail, Fluidd, or Octoprint) installed on your printer. If not, you can use [KIAUH](https://github.com/dw-0/kiauh) to facilitate the process. 10 | 11 | Then, execute the following command over SSH. The script will clone this GitHub repository to your device's home directory, and symlink the required files into the Klipper "extras" folder. 12 | 13 | ``` 14 | wget -O - https://raw.githubusercontent.com/blankhaus/klipper-filter_monitor/main/install.sh | bash 15 | ``` 16 | 17 | Then, add the following to moonraker.conf to enable automatic updates: 18 | 19 | ```ini 20 | [update_manager filter_monitor] 21 | type: git_repo 22 | path: ~/klipper-filter_monitor 23 | origin: https://github.com/blankhaus/klipper-filter_monitor.git 24 | managed_services: klipper moonraker 25 | primary_branch: main 26 | install_script: install.sh 27 | ``` 28 | 29 | ## Usage 30 | 31 | #### Quick Configuration 32 | 33 | ```ini 34 | [filter_monitor air_filter] 35 | fan: fan_generic bed_fans 36 | ``` 37 | 38 | #### Full Configuration 39 | 40 | ```ini 41 | [filter_monitor another_air_filter] 42 | fan: fan_generic bed_fans # e.g fan_generic bed_filter, heater_generic heated_chamber, etc 43 | max_runtime_hours: 50 # Defaults to 50 hours 44 | max_days: 30 # Defaults to 30 days 45 | interval: 30 # Defaults to 30 seconds 46 | stats_caption: "" 47 | # Output override for FILTER_STATS macro. Defaults to " at". e.g. Air Filter at 98% 48 | expiry_gcode: # Executed when filter meets threshold condition 49 | path: ~/printer_data/config/plugins/filter_monitor # Folder where filter data is stored 50 | ``` 51 | 52 | #### Macros 53 | 54 | ```ini 55 | FILTER_STATS NAME= [EXTENDED=1] 56 | ``` 57 | 58 | ```ini 59 | RESET_FILTER NAME= 60 | ``` 61 | 62 | ## Removing Plugin 63 | 64 | To uninstall this plugin, execute the following command over SSH. The script will remove any symlinked files related to this plugin from the Klipper "extras" and "plugins" folders. 65 | 66 | ``` 67 | wget -O - https://raw.githubusercontent.com/blankhaus/klipper-filter_monitor/main/uninstall.sh | bash 68 | ``` 69 | 70 | ## Support 71 | 72 | Feel free to shoot me a message on Discord. You'll find me under **mut3x_** on either the Voron or Klipper servers. 73 | 74 | [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/M4M3125C21) 75 | -------------------------------------------------------------------------------- /docs/images/example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/blankhaus/klipper-filter_monitor/67444fc02bf5d4bf0be7d30f50c1139646664214/docs/images/example.png -------------------------------------------------------------------------------- /filter_monitor.py: -------------------------------------------------------------------------------- 1 | # Monitor air filter runtime and expiry 2 | # 3 | # Copyright (C) 2024 Blankhaus Ltd. 4 | # 5 | # This file may be distributed under the terms of the GNU GPLv3 license. 6 | 7 | import ast 8 | import csv 9 | import datetime 10 | import logging 11 | import math 12 | import os 13 | import time 14 | 15 | SEC_PER_DAY = 86400 16 | SEC_PER_HOUR = 3600 17 | SEC_PER_MIN = 60 18 | 19 | FAN_TYPES = [ 20 | "fan", 21 | "fan_generic", 22 | "controller_fan", 23 | "heater_fan", 24 | "temperature_fan" 25 | ] 26 | 27 | COLORS = [ 28 | "primary", 29 | "secondary", 30 | "accent" 31 | "info", 32 | "success", 33 | "error", 34 | "warning" 35 | ] 36 | 37 | class FilterMonitor: 38 | def __init__(self, config): 39 | self.printer = config.get_printer() 40 | self.printer.register_event_handler( 41 | "klippy:connect", 42 | self._handle_connect 43 | ) 44 | self.printer.register_event_handler( 45 | "klippy:shutdown", 46 | self._handle_shutdown 47 | ) 48 | self.printer.register_event_handler( 49 | "klippy:ready", 50 | self._handle_ready 51 | ) 52 | self.printer.register_event_handler( 53 | "gcode:request_restart", 54 | self._handle_restart 55 | ) 56 | self.printer.register_event_handler( 57 | "idle_timeout:idle", 58 | self._handle_idle 59 | ) 60 | 61 | self.reactor = self.printer.get_reactor() 62 | self.gcode = self.printer.lookup_object("gcode") 63 | 64 | self.name = config.get_name().split()[-1] 65 | self.pretty_name = None 66 | 67 | self.fan_section = config.get("fan", "").strip("\"") 68 | self.fan_type = None 69 | self.fan_name = None 70 | self.fan = None 71 | 72 | self.stats_caption = config.get("stats_caption", "").strip("\"") 73 | 74 | self.max_runtime_hours = config.getfloat("max_runtime_hours", 50.0) 75 | self.max_days = config.getfloat("max_days", 30.0) 76 | 77 | gcode_macro = self.printer.load_object(config, "gcode_macro") 78 | self.expiry_gcode = None 79 | if config.get("expiry_gcode", None) is not None: 80 | self.expiry_gcode = gcode_macro.load_template( 81 | config, "expiry_gcode", "" 82 | ) 83 | 84 | self.interval = config.getfloat("interval", 60, above=0.0) 85 | self.path = os.path.expanduser(config.get("path", "~/printer_data/config/plugins/filter_monitor")) 86 | self.file = os.path.join(self.path, self.name + ".csv") 87 | 88 | self.filter_last_active = None 89 | self.filter_last_notified = None 90 | self.filter_last_reset = None 91 | self.filter_runtime = 0.0 92 | self.filter_total_runtime = 0.0 93 | self.filter_reset_count = 0 94 | self.filter_active = False 95 | self.filter_expired = False 96 | self.filter_percent_r = None 97 | self.filter_runtime_r = None 98 | self.filter_days_r = None 99 | 100 | self.monitor_timer = None 101 | 102 | self.gcode.register_mux_command( 103 | "FILTER_STATS", 104 | "NAME", 105 | self.name, 106 | self.cmd_FILTER_STATS 107 | ) 108 | self.gcode.register_mux_command( 109 | "RESET_FILTER", 110 | "NAME", 111 | self.name, 112 | self.cmd_RESET_FILTER 113 | ) 114 | 115 | def _handle_connect(self): 116 | if self.fan_section == "": 117 | self._log_exception("Fan is required.") 118 | 119 | fan_split = self.fan_section.split(" ") 120 | if len(fan_split) != 2: 121 | self._log_exception("Fan is invalid.") 122 | 123 | self.fan_type, self.fan_name = fan_split 124 | 125 | if self.fan_type == "heater_generic": 126 | heaters = self.printer.lookup_object("heaters") 127 | self.fan = heaters.lookup_heater(self.fan_name) 128 | elif self.fan_type in FAN_TYPES: 129 | self.fan = self.printer.lookup_object("fan", self.fan_name) 130 | else: 131 | self._log_exception("Fan type '%s' is unsupported." % self.fan_type) 132 | 133 | if self.fan is None: 134 | self._log_exception("Fan '%s' not found." % self.fan_section) 135 | 136 | if not os.path.exists(self.path): 137 | self._log_exception("Specified path is either invalid or does not exist.") 138 | 139 | self.pretty_name = " ".join(self.name.split("_")).title() 140 | 141 | if self.stats_caption == "": 142 | self.stats_caption = "%s at" % self.pretty_name 143 | 144 | self._restore() 145 | 146 | def _handle_shutdown(self): 147 | self._update(stop_timer=True) 148 | 149 | def _handle_restart(self, print_time): 150 | self._update(stop_timer=True) 151 | 152 | def _handle_idle(self, print_time): 153 | self._update() 154 | 155 | def _handle_ready(self): 156 | self._update() 157 | self.monitor_timer = self.reactor.register_timer( 158 | self._monitor_event, 159 | self.reactor.NOW + self.interval 160 | ) 161 | 162 | def _monitor_event(self, event_time): 163 | return self._update(event_time) 164 | 165 | def _update(self, event_time = None, stop_timer=False, notify=False): 166 | if self.monitor_timer is not None: 167 | if event_time is None: 168 | self.reactor.update_timer( 169 | self.monitor_timer, 170 | self.reactor.NEVER 171 | ) 172 | 173 | self._monitor() 174 | 175 | if notify or ( 176 | self.filter_expired and 177 | self.filter_last_notified is None and 178 | event_time is not None 179 | ): 180 | self._notify() 181 | 182 | self._persist() 183 | 184 | if self.monitor_timer is not None: 185 | if event_time is None and not stop_timer: 186 | self.reactor.update_timer( 187 | self.monitor_timer, 188 | self.reactor.NOW + self.interval 189 | ) 190 | 191 | if event_time is not None and not stop_timer: 192 | return event_time + self.interval 193 | 194 | return self.reactor.NEVER 195 | 196 | def _restore(self): 197 | if not os.path.isfile(self.file): 198 | self._log_info("No persisted file found!") 199 | return 200 | 201 | try: 202 | with open(self.file, "r", newline="", encoding="utf-8") as f: 203 | csv_reader = csv.reader(f, delimiter=",") 204 | for row in csv_reader: 205 | self.filter_last_reset = ast.literal_eval(row[0]) 206 | self.filter_runtime = ast.literal_eval(row[1]) 207 | self.filter_total_runtime = ast.literal_eval(row[2]) 208 | self.filter_reset_count = ast.literal_eval(row[3]) 209 | break 210 | except IOError as e: 211 | self._log_exception("%s %s" % (self.file, str(e))) 212 | except: 213 | self._log_exception("Unable to parse %s" % self.file) 214 | 215 | def _monitor(self): 216 | now = time.time() 217 | 218 | if self.filter_last_reset is None: 219 | self.filter_last_reset = now 220 | 221 | if self.fan_type == "heater_generic": 222 | self.filter_active = self.fan.last_pwm_value > 0.0 223 | else: 224 | status = self.fan.get_status(self.reactor.NOW) 225 | self.filter_active = status["speed"] > 0.0 226 | 227 | if self.filter_active: 228 | if self.filter_last_active is not None: 229 | runtime = now - self.filter_last_active 230 | self.filter_runtime += runtime 231 | self.filter_total_runtime += runtime 232 | 233 | self.filter_last_active = now 234 | else: 235 | self.filter_last_active = None 236 | 237 | runtime_d1 = datetime.timedelta(hours=self.max_runtime_hours) 238 | runtime_d2 = datetime.timedelta(seconds=self.filter_runtime) 239 | runtime_d = (runtime_d1 - runtime_d2).total_seconds() 240 | runtime_p = runtime_d / runtime_d1.total_seconds() 241 | 242 | days_d1 = datetime.timedelta(days=self.max_days) 243 | days_d2 = datetime.timedelta(seconds=now - self.filter_last_reset) 244 | days_d = (days_d1 - days_d2).total_seconds() 245 | days_p = days_d / days_d1.total_seconds() 246 | 247 | self.filter_percent_r = max(min(runtime_p, days_p) * 100, 0) 248 | self.filter_expired = self.filter_percent_r <= 0 249 | 250 | if self.filter_expired: 251 | self.filter_runtime_r = 0 252 | self.filter_days_r = 0 253 | else: 254 | self.filter_runtime_r = max(runtime_d, 0) 255 | self.filter_days_r = max(days_d, 0) 256 | 257 | def _persist(self): 258 | try: 259 | with open(self.file, "w", newline="", encoding="utf-8") as f: 260 | csv_writer = csv.writer(f, delimiter=",") 261 | csv_writer.writerow([ 262 | "%f" % self.filter_last_reset, 263 | "%f" % self.filter_runtime, 264 | "%f" % self.filter_total_runtime, 265 | "%d" % self.filter_reset_count 266 | ]) 267 | except IOError as e: 268 | self._log_exception("%s %s" % (self.file, str(e))) 269 | except: 270 | self._log_exception("Unable to write to %s" % self.file) 271 | 272 | def _notify(self): 273 | self.gcode.respond_info(self._format_status()) 274 | 275 | if not self.filter_expired: 276 | return 277 | 278 | if self.expiry_gcode is not None: 279 | try: 280 | self.gcode.run_script(self.expiry_gcode.render()) 281 | except: 282 | self._log_exception("Error executing expiry gcode") 283 | 284 | self.filter_last_notified = time.time() 285 | 286 | def _format_msg(self, msg, separator=" ", custom_caption=None, color=None): 287 | caption = self.pretty_name 288 | if custom_caption is not None: 289 | caption = custom_caption 290 | 291 | return self._colorize_msg( 292 | ("%s%s%s" % (caption, separator, msg)), color 293 | ) 294 | 295 | def _format_log(self, msg): 296 | return ( 297 | "filter_monitor %s: %s" % ( 298 | self.name, msg 299 | ) 300 | ) 301 | 302 | def _format_status(self, extended=False): 303 | extended_msg = "" 304 | if extended: 305 | extended_msg = ( 306 | "\nTotal Runtime: %s Resets: %d" % ( 307 | self._format_runtime(self.filter_total_runtime), 308 | self.filter_reset_count 309 | ) 310 | ) 311 | 312 | maintenance_msg = "" 313 | if self.filter_expired: 314 | maintenance_msg = self._colorize_msg( 315 | "\nNeeds maintenance!", color="warning" 316 | ) 317 | 318 | return self._format_msg( 319 | "%s\nRuntime: %s Days: %.01f%s%s" % ( 320 | self._format_percent(self.filter_percent_r), 321 | self._format_runtime(self.filter_runtime_r), 322 | self.filter_days_r / SEC_PER_DAY, 323 | extended_msg, 324 | maintenance_msg 325 | ), 326 | custom_caption=self.stats_caption 327 | ) 328 | 329 | def _format_percent(self, percent): 330 | color = "success" 331 | if percent <= 10.0: 332 | color = "error" 333 | elif percent <= 25.0: 334 | color = "error" 335 | 336 | return self._colorize_msg( 337 | "%.01f%%" % percent, color 338 | ) 339 | 340 | def _format_runtime(self, runtime): 341 | return ( 342 | "%02d:%02d" % ( 343 | math.floor(runtime / SEC_PER_HOUR), 344 | (runtime % SEC_PER_HOUR) / SEC_PER_MIN 345 | ) 346 | ) 347 | 348 | def _colorize_msg(self, msg, color): 349 | if color in COLORS: 350 | return ( 351 | "%s" % ( 352 | color, 353 | msg 354 | ) 355 | ) 356 | return msg 357 | 358 | def _log_info(self, msg): 359 | logging.info(self._format_log(msg)) 360 | 361 | def _log_exception(self, msg): 362 | formatted_msg = self._format_log(msg) 363 | logging.exception(formatted_msg) 364 | 365 | raise self.printer.command_error(formatted_msg) 366 | 367 | def get_status(self, eventtime): 368 | return { 369 | "filter_last_active": self.filter_last_active, 370 | "filter_last_notified": self.filter_last_notified, 371 | "filter_last_reset": self.filter_last_reset, 372 | "filter_runtime": self.filter_runtime, 373 | "filter_total_runtime": self.filter_total_runtime, 374 | "filter_reset_count": self.filter_reset_count, 375 | "filter_active": self.filter_active, 376 | "filter_expired": self.filter_expired, 377 | "filter_percent_r": self.filter_percent_r, 378 | "filter_runtime_r": self.filter_runtime_r, 379 | "filter_days_r": self.filter_days_r 380 | } 381 | 382 | def cmd_FILTER_STATS(self, gcmd): 383 | self._update() 384 | 385 | gcmd.respond_info( 386 | self._format_status( 387 | extended=gcmd.get_int("EXTENDED", 0) == 1 388 | ) 389 | ) 390 | 391 | def cmd_RESET_FILTER(self, gcmd): 392 | if self.filter_active: 393 | gcmd.respond_info( 394 | self._format_msg("can't be reset while active!", color="error") 395 | ) 396 | else: 397 | self.filter_last_reset = time.time() 398 | self.filter_runtime = 0.0 399 | self.filter_reset_count += 1 400 | self._update() 401 | 402 | gcmd.respond_info( 403 | self._format_msg("reset!", color="success") 404 | ) 405 | 406 | def load_config_prefix(config): 407 | return FilterMonitor(config) 408 | 409 | -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # =========================================================== 4 | # Copyright (C) 2024 Blankhaus Ltd. 5 | # =========================================================== 6 | 7 | KLIPPER_PATH="${HOME}/klipper" 8 | GIT_PATH="${HOME}/klipper-filter_monitor" 9 | 10 | set -eu 11 | export LC_ALL=C 12 | 13 | function preflight_checks { 14 | if [ "$EUID" -eq 0 ]; then 15 | echo "[PRE-CHECK] This script must not be run as root!" 16 | echo 17 | exit -1 18 | fi 19 | 20 | if [ "$(sudo systemctl list-units --full -all -t service --no-legend | grep -F 'klipper.service')" ]; then 21 | echo "[PRE-CHECK] Klipper service found!" 22 | else 23 | echo "[ERROR] Klipper service not found, please install Klipper first!" 24 | echo 25 | exit -1 26 | fi 27 | 28 | echo "[PRE-CHECK] Ready to install plugin." 29 | 30 | local install_answer 31 | read < /dev/tty -rp "[PRE-CHECK] Do you want to continue? [Y/n] " install_answer 32 | if [[ -z "$install_answer" ]]; then 33 | install_answer="n" 34 | fi 35 | install_answer="${install_answer,,}" 36 | 37 | if [[ "$install_answer" =~ ^(yes|y)$ ]]; then 38 | echo "[PRE-CHECK] Installation confirmed!" 39 | else 40 | echo "[PRE-CHECK] Installation canceled!" 41 | echo 42 | exit -1 43 | fi 44 | } 45 | 46 | function check_download { 47 | local gitdirname gitbasename 48 | gitdirname="$(dirname ${GIT_PATH})" 49 | gitbasename="$(basename ${GIT_PATH})" 50 | 51 | if [ ! -d "${GIT_PATH}" ]; then 52 | echo "[GIT] Cloning repository..." 53 | if git -C $gitdirname clone https://github.com/blankhaus/klipper-filter_monitor.git $gitbasename; then 54 | echo "[GIT] Cloning complete!" 55 | else 56 | echo "[GIT] Cloning failed!" 57 | echo 58 | exit -1 59 | fi 60 | else 61 | echo "[GIT] Repository already exists!" 62 | fi 63 | } 64 | 65 | function install_plugin { 66 | printf "[INSTALL] Linking plugin to Klipper... " 67 | 68 | if [ -d "${KLIPPER_PATH}/klippy/plugins" ]; then 69 | ln -fsn ${GIT_PATH}/filter_monitor.py ${KLIPPER_PATH}/klippy/plugins 70 | else 71 | ln -fsn ${GIT_PATH}/filter_monitor.py ${KLIPPER_PATH}/klippy/extras 72 | fi 73 | 74 | chmod +x ${GIT_PATH}/install.sh 75 | chmod +x ${GIT_PATH}/uninstall.sh 76 | 77 | echo "OK!" 78 | } 79 | 80 | function restart_klipper { 81 | printf "[POST-INSTALL] Restarting Klipper... " 82 | sudo systemctl restart klipper 83 | echo "OK!" 84 | } 85 | 86 | echo 87 | echo "______ _ _ _ " 88 | echo "| ___ \ | | | | | " 89 | echo "| |_/ / | __ _ _ __ | | _| |__ __ _ _ _ ___ " 90 | echo "| ___ \ |/ _' | '_ \| |/ / '_ \ / _' | | | / __|" 91 | echo "| |_/ / | (_| | | | | <| | | | (_| | |_| \__ \\" 92 | echo "\____/|_|\__,_|_| |_|_|\_\_| |_|\__,_|\__,_|___/" 93 | echo 94 | echo "================================================" 95 | echo " FILTER MONITOR " 96 | echo "------------------------------------------------" 97 | echo "This Klipper plugin monitors the runtime of air " 98 | echo "filters (Nevermore, THE FILTER, etc), and " 99 | echo "triggers notifications and/or executes G-code " 100 | echo "when threshold conditions, such as max runtime " 101 | echo "or lifetime hours, are met. These monitoring " 102 | echo "checks also occur on pre-defined system events " 103 | echo "and keep track of total fan runtime. " 104 | echo "================================================" 105 | echo 106 | 107 | preflight_checks 108 | check_download 109 | install_plugin 110 | restart_klipper 111 | 112 | echo "[POST-INSTALL] Installation complete!" 113 | echo 114 | -------------------------------------------------------------------------------- /uninstall.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # =========================================================== 4 | # Copyright (C) 2024 Blankhaus Ltd. 5 | # =========================================================== 6 | 7 | KLIPPER_PATH="${HOME}/klipper" 8 | 9 | set -eu 10 | export LC_ALL=C 11 | 12 | function preflight_checks { 13 | if [ "$EUID" -eq 0 ]; then 14 | echo "[PRE-CHECK] This script must not be run as root!" 15 | echo 16 | exit -1 17 | fi 18 | 19 | if [ "$(sudo systemctl list-units --full -all -t service --no-legend | grep -F 'klipper.service')" ]; then 20 | echo "[PRE-CHECK] Klipper service found!" 21 | else 22 | echo "[ERROR] Klipper service not found, please install Klipper first!" 23 | echo 24 | exit -1 25 | fi 26 | 27 | echo "[PRE-CHECK] Ready to uninstall plugin." 28 | 29 | local uninstall_answer 30 | read < /dev/tty -rp "[PRE-CHECK] Do you want to continue? [Y/n] " uninstall_answer 31 | if [[ -z "$uninstall_answer" ]]; then 32 | uninstall_answer="n" 33 | fi 34 | uninstall_answer="${uninstall_answer,,}" 35 | 36 | if [[ "$uninstall_answer" =~ ^(yes|y)$ ]]; then 37 | echo "[PRE-CHECK] Uninstallation confirmed!" 38 | else 39 | echo "[PRE-CHECK] Uninstallation canceled!" 40 | echo 41 | exit -1 42 | fi 43 | } 44 | 45 | function uninstall_plugin { 46 | printf "[UNINSTALL] Removing plugin files from Klipper... " 47 | 48 | if [ -f "${KLIPPER_PATH}/klippy/plugins/filter_monitor.py" ]; then 49 | rm -f ${KLIPPER_PATH}/klippy/plugins/filter_monitor.py 50 | fi 51 | 52 | if [ -f "${KLIPPER_PATH}/klippy/extras/filter_monitor.py" ]; then 53 | rm -f ${KLIPPER_PATH}/klippy/extras/filter_monitor.py 54 | fi 55 | 56 | echo "OK!" 57 | } 58 | 59 | function restart_klipper { 60 | printf "[POST-UNINSTALL] Restarting Klipper... " 61 | sudo systemctl restart klipper 62 | echo "OK!" 63 | } 64 | 65 | echo 66 | echo "______ _ _ _ " 67 | echo "| ___ \ | | | | | " 68 | echo "| |_/ / | __ _ _ __ | | _| |__ __ _ _ _ ___ " 69 | echo "| ___ \ |/ _' | '_ \| |/ / '_ \ / _' | | | / __|" 70 | echo "| |_/ / | (_| | | | | <| | | | (_| | |_| \__ \\" 71 | echo "\____/|_|\__,_|_| |_|_|\_\_| |_|\__,_|\__,_|___/" 72 | echo 73 | echo "================================================" 74 | echo " FILTER MONITOR " 75 | echo "------------------------------------------------" 76 | echo "This Klipper plugin monitors the runtime of air " 77 | echo "filters (Nevermore, THE FILTER, etc), and " 78 | echo "triggers notifications and/or executes G-code " 79 | echo "when threshold conditions, such as max runtime " 80 | echo "or lifetime hours, are met. These monitoring " 81 | echo "checks also occur on pre-defined system events " 82 | echo "and keep track of total fan runtime. " 83 | echo "================================================" 84 | echo 85 | 86 | preflight_checks 87 | uninstall_plugin 88 | restart_klipper 89 | 90 | echo "[POST-UNINSTALL] Uninstallation complete!" 91 | echo 92 | --------------------------------------------------------------------------------