├── .github └── workflows │ └── build.yml ├── .gitignore ├── .pylintrc ├── LICENSE ├── Pipfile ├── README.md ├── alarmpy ├── __init__.py ├── alarmpy.py ├── data │ └── labels.json └── tests │ ├── __init__.py │ └── test_alarmpy.py ├── example.png └── setup.py /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: [push] 4 | 5 | jobs: 6 | build: 7 | runs-on: ubuntu-latest 8 | strategy: 9 | matrix: 10 | python-version: [3.7, 3.8, 3.9, "3.10", "3.11"] 11 | 12 | steps: 13 | - uses: actions/checkout@v3 14 | - name: Set up Python ${{ matrix.python-version }} 15 | uses: actions/setup-python@v3 16 | with: 17 | python-version: ${{ matrix.python-version }} 18 | - name: Install pip and testing tools 19 | run: | 20 | python -m pip install --upgrade pipenv 21 | pipenv install -d 22 | - name: Check formatting with black 23 | run: | 24 | pipenv run formatcheck 25 | - name: Run pylint 26 | run: | 27 | pipenv run lint 28 | - name: Test with pytest 29 | run: | 30 | pipenv run test 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | Pipfile.lock 2 | 3 | __pycache__ 4 | *.pyc 5 | 6 | build/ 7 | dist/ 8 | *.egg-info/ 9 | -------------------------------------------------------------------------------- /.pylintrc: -------------------------------------------------------------------------------- 1 | [MASTER] 2 | 3 | # A comma-separated list of package or module names from where C extensions may 4 | # be loaded. Extensions are loading into the active Python interpreter and may 5 | # run arbitrary code. 6 | extension-pkg-allow-list= 7 | 8 | # A comma-separated list of package or module names from where C extensions may 9 | # be loaded. Extensions are loading into the active Python interpreter and may 10 | # run arbitrary code. (This is an alternative name to extension-pkg-allow-list 11 | # for backward compatibility.) 12 | extension-pkg-whitelist= 13 | 14 | # Specify a score threshold to be exceeded before program exits with error. 15 | fail-under=10.0 16 | 17 | # Files or directories to be skipped. They should be base names, not paths. 18 | ignore=CVS 19 | 20 | # Files or directories matching the regex patterns are skipped. The regex 21 | # matches against base names, not paths. 22 | ignore-patterns= 23 | 24 | # Python code to execute, usually for sys.path manipulation such as 25 | # pygtk.require(). 26 | #init-hook= 27 | 28 | # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the 29 | # number of processors available to use. 30 | jobs=1 31 | 32 | # Control the amount of potential inferred values when inferring a single 33 | # object. This can help the performance when dealing with large functions or 34 | # complex, nested conditions. 35 | limit-inference-results=100 36 | 37 | # List of plugins (as comma separated values of python module names) to load, 38 | # usually to register additional checkers. 39 | load-plugins= 40 | 41 | # Pickle collected data for later comparisons. 42 | persistent=yes 43 | 44 | # When enabled, pylint would attempt to guess common misconfiguration and emit 45 | # user-friendly hints instead of false-positive error messages. 46 | suggestion-mode=yes 47 | 48 | # Allow loading of arbitrary C extensions. Extensions are imported into the 49 | # active Python interpreter and may run arbitrary code. 50 | unsafe-load-any-extension=no 51 | 52 | 53 | [MESSAGES CONTROL] 54 | 55 | # Only show warnings with the listed confidence levels. Leave empty to show 56 | # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED. 57 | confidence= 58 | 59 | # Disable the message, report, category or checker with the given id(s). You 60 | # can either give multiple identifiers separated by comma (,) or put this 61 | # option multiple times (only on the command line, not in the configuration 62 | # file where it should appear only once). You can also use "--disable=all" to 63 | # disable everything first and then reenable specific checks. For example, if 64 | # you want to run only the similarities checker, you can use "--disable=all 65 | # --enable=similarities". If you want to run only the classes checker, but have 66 | # no Warning level messages displayed, use "--disable=all --enable=classes 67 | # --disable=W". 68 | disable=print-statement, 69 | parameter-unpacking, 70 | unpacking-in-except, 71 | old-raise-syntax, 72 | backtick, 73 | import-star-module-level, 74 | raw-checker-failed, 75 | bad-inline-option, 76 | locally-disabled, 77 | file-ignored, 78 | suppressed-message, 79 | useless-suppression, 80 | deprecated-pragma, 81 | use-symbolic-message-instead, 82 | apply-builtin, 83 | basestring-builtin, 84 | buffer-builtin, 85 | cmp-builtin, 86 | coerce-builtin, 87 | execfile-builtin, 88 | file-builtin, 89 | long-builtin, 90 | raw_input-builtin, 91 | reduce-builtin, 92 | standarderror-builtin, 93 | unicode-builtin, 94 | xrange-builtin, 95 | coerce-method, 96 | delslice-method, 97 | getslice-method, 98 | setslice-method, 99 | no-absolute-import, 100 | old-division, 101 | dict-iter-method, 102 | dict-view-method, 103 | next-method-called, 104 | metaclass-assignment, 105 | indexing-exception, 106 | raising-string, 107 | reload-builtin, 108 | oct-method, 109 | hex-method, 110 | nonzero-method, 111 | cmp-method, 112 | input-builtin, 113 | round-builtin, 114 | intern-builtin, 115 | unichr-builtin, 116 | map-builtin-not-iterating, 117 | zip-builtin-not-iterating, 118 | range-builtin-not-iterating, 119 | filter-builtin-not-iterating, 120 | using-cmp-argument, 121 | div-method, 122 | idiv-method, 123 | rdiv-method, 124 | exception-message-attribute, 125 | invalid-str-codec, 126 | sys-max-int, 127 | bad-python3-import, 128 | deprecated-string-function, 129 | deprecated-str-translate-call, 130 | deprecated-itertools-function, 131 | deprecated-types-field, 132 | next-method-defined, 133 | dict-items-not-iterating, 134 | dict-keys-not-iterating, 135 | dict-values-not-iterating, 136 | deprecated-operator-function, 137 | deprecated-urllib-function, 138 | xreadlines-attribute, 139 | deprecated-sys-function, 140 | exception-escape, 141 | comprehension-escape, 142 | broad-exception-raised 143 | 144 | # Enable the message, report, category or checker with the given id(s). You can 145 | # either give multiple identifier separated by comma (,) or put this option 146 | # multiple time (only on the command line, not in the configuration file where 147 | # it should appear only once). See also the "--disable" option for examples. 148 | enable=c-extension-no-member 149 | 150 | 151 | [REPORTS] 152 | 153 | # Python expression which should return a score less than or equal to 10. You 154 | # have access to the variables 'error', 'warning', 'refactor', and 'convention' 155 | # which contain the number of messages in each category, as well as 'statement' 156 | # which is the total number of statements analyzed. This score is used by the 157 | # global evaluation report (RP0004). 158 | evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) 159 | 160 | # Template used to display messages. This is a python new-style format string 161 | # used to format the message information. See doc for all details. 162 | #msg-template= 163 | 164 | # Set the output format. Available formats are text, parseable, colorized, json 165 | # and msvs (visual studio). You can also give a reporter class, e.g. 166 | # mypackage.mymodule.MyReporterClass. 167 | output-format=text 168 | 169 | # Tells whether to display a full report or only the messages. 170 | reports=no 171 | 172 | # Activate the evaluation score. 173 | score=yes 174 | 175 | 176 | [REFACTORING] 177 | 178 | # Maximum number of nested blocks for function / method body 179 | max-nested-blocks=5 180 | 181 | # Complete name of functions that never returns. When checking for 182 | # inconsistent-return-statements if a never returning function is called then 183 | # it will be considered as an explicit return statement and no message will be 184 | # printed. 185 | never-returning-functions=sys.exit,argparse.parse_error 186 | 187 | 188 | [TYPECHECK] 189 | 190 | # List of decorators that produce context managers, such as 191 | # contextlib.contextmanager. Add to this list to register other decorators that 192 | # produce valid context managers. 193 | contextmanager-decorators=contextlib.contextmanager 194 | 195 | # List of members which are set dynamically and missed by pylint inference 196 | # system, and so shouldn't trigger E1101 when accessed. Python regular 197 | # expressions are accepted. 198 | generated-members= 199 | 200 | # Tells whether missing members accessed in mixin class should be ignored. A 201 | # mixin class is detected if its name ends with "mixin" (case insensitive). 202 | ignore-mixin-members=yes 203 | 204 | # Tells whether to warn about missing members when the owner of the attribute 205 | # is inferred to be None. 206 | ignore-none=yes 207 | 208 | # This flag controls whether pylint should warn about no-member and similar 209 | # checks whenever an opaque object is returned when inferring. The inference 210 | # can return multiple potential results while evaluating a Python object, but 211 | # some branches might not be evaluated, which results in partial inference. In 212 | # that case, it might be useful to still emit no-member and other checks for 213 | # the rest of the inferred objects. 214 | ignore-on-opaque-inference=yes 215 | 216 | # List of class names for which member attributes should not be checked (useful 217 | # for classes with dynamically set attributes). This supports the use of 218 | # qualified names. 219 | ignored-classes=optparse.Values,thread._local,_thread._local 220 | 221 | # List of module names for which member attributes should not be checked 222 | # (useful for modules/projects where namespaces are manipulated during runtime 223 | # and thus existing member attributes cannot be deduced by static analysis). It 224 | # supports qualified module names, as well as Unix pattern matching. 225 | ignored-modules= 226 | 227 | # Show a hint with possible names when a member name was not found. The aspect 228 | # of finding the hint is based on edit distance. 229 | missing-member-hint=yes 230 | 231 | # The minimum edit distance a name should have in order to be considered a 232 | # similar match for a missing member name. 233 | missing-member-hint-distance=1 234 | 235 | # The total number of similar names that should be taken in consideration when 236 | # showing a hint for a missing member. 237 | missing-member-max-choices=1 238 | 239 | # List of decorators that change the signature of a decorated function. 240 | signature-mutators= 241 | 242 | 243 | [STRING] 244 | 245 | # This flag controls whether inconsistent-quotes generates a warning when the 246 | # character used as a quote delimiter is used inconsistently within a module. 247 | check-quote-consistency=no 248 | 249 | # This flag controls whether the implicit-str-concat should generate a warning 250 | # on implicit string concatenation in sequences defined over several lines. 251 | check-str-concat-over-line-jumps=no 252 | 253 | 254 | [SIMILARITIES] 255 | 256 | # Ignore comments when computing similarities. 257 | ignore-comments=yes 258 | 259 | # Ignore docstrings when computing similarities. 260 | ignore-docstrings=yes 261 | 262 | # Ignore imports when computing similarities. 263 | ignore-imports=no 264 | 265 | # Minimum lines number of a similarity. 266 | min-similarity-lines=4 267 | 268 | 269 | [MISCELLANEOUS] 270 | 271 | # List of note tags to take in consideration, separated by a comma. 272 | notes=FIXME, 273 | XXX, 274 | TODO 275 | 276 | # Regular expression of note tags to take in consideration. 277 | #notes-rgx= 278 | 279 | 280 | [BASIC] 281 | 282 | # Naming style matching correct argument names. 283 | argument-naming-style=snake_case 284 | 285 | # Regular expression matching correct argument names. Overrides argument- 286 | # naming-style. 287 | #argument-rgx= 288 | 289 | # Naming style matching correct attribute names. 290 | attr-naming-style=snake_case 291 | 292 | # Regular expression matching correct attribute names. Overrides attr-naming- 293 | # style. 294 | #attr-rgx= 295 | 296 | # Bad variable names which should always be refused, separated by a comma. 297 | bad-names=foo, 298 | bar, 299 | baz, 300 | toto, 301 | tutu, 302 | tata 303 | 304 | # Bad variable names regexes, separated by a comma. If names match any regex, 305 | # they will always be refused 306 | bad-names-rgxs= 307 | 308 | # Naming style matching correct class attribute names. 309 | class-attribute-naming-style=any 310 | 311 | # Regular expression matching correct class attribute names. Overrides class- 312 | # attribute-naming-style. 313 | #class-attribute-rgx= 314 | 315 | # Naming style matching correct class constant names. 316 | class-const-naming-style=UPPER_CASE 317 | 318 | # Regular expression matching correct class constant names. Overrides class- 319 | # const-naming-style. 320 | #class-const-rgx= 321 | 322 | # Naming style matching correct class names. 323 | class-naming-style=PascalCase 324 | 325 | # Regular expression matching correct class names. Overrides class-naming- 326 | # style. 327 | #class-rgx= 328 | 329 | # Naming style matching correct constant names. 330 | const-naming-style=UPPER_CASE 331 | 332 | # Regular expression matching correct constant names. Overrides const-naming- 333 | # style. 334 | #const-rgx= 335 | 336 | # Minimum line length for functions/classes that require docstrings, shorter 337 | # ones are exempt. 338 | docstring-min-length=-1 339 | 340 | # Naming style matching correct function names. 341 | function-naming-style=snake_case 342 | 343 | # Regular expression matching correct function names. Overrides function- 344 | # naming-style. 345 | #function-rgx= 346 | 347 | # Good variable names which should always be accepted, separated by a comma. 348 | good-names=i, 349 | j, 350 | k, 351 | ex, 352 | Run, 353 | _ 354 | 355 | # Good variable names regexes, separated by a comma. If names match any regex, 356 | # they will always be accepted 357 | good-names-rgxs= 358 | 359 | # Include a hint for the correct naming format with invalid-name. 360 | include-naming-hint=no 361 | 362 | # Naming style matching correct inline iteration names. 363 | inlinevar-naming-style=any 364 | 365 | # Regular expression matching correct inline iteration names. Overrides 366 | # inlinevar-naming-style. 367 | #inlinevar-rgx= 368 | 369 | # Naming style matching correct method names. 370 | method-naming-style=snake_case 371 | 372 | # Regular expression matching correct method names. Overrides method-naming- 373 | # style. 374 | #method-rgx= 375 | 376 | # Naming style matching correct module names. 377 | module-naming-style=snake_case 378 | 379 | # Regular expression matching correct module names. Overrides module-naming- 380 | # style. 381 | #module-rgx= 382 | 383 | # Colon-delimited sets of names that determine each other's naming style when 384 | # the name regexes allow several styles. 385 | name-group= 386 | 387 | # Regular expression which should only match function or class names that do 388 | # not require a docstring. 389 | no-docstring-rgx=^_ 390 | 391 | # List of decorators that produce properties, such as abc.abstractproperty. Add 392 | # to this list to register other decorators that produce valid properties. 393 | # These decorators are taken in consideration only for invalid-name. 394 | property-classes=abc.abstractproperty 395 | 396 | # Naming style matching correct variable names. 397 | variable-naming-style=snake_case 398 | 399 | # Regular expression matching correct variable names. Overrides variable- 400 | # naming-style. 401 | #variable-rgx= 402 | 403 | 404 | [FORMAT] 405 | 406 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF. 407 | expected-line-ending-format= 408 | 409 | # Regexp for a line that is allowed to be longer than the limit. 410 | ignore-long-lines=^\s*(# )??$ 411 | 412 | # Number of spaces of indent required inside a hanging or continued line. 413 | indent-after-paren=4 414 | 415 | # String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 416 | # tab). 417 | indent-string=' ' 418 | 419 | # Maximum number of characters on a single line. 420 | max-line-length=100 421 | 422 | # Maximum number of lines in a module. 423 | max-module-lines=1000 424 | 425 | # Allow the body of a class to be on the same line as the declaration if body 426 | # contains single statement. 427 | single-line-class-stmt=no 428 | 429 | # Allow the body of an if to be on the same line as the test if there is no 430 | # else. 431 | single-line-if-stmt=no 432 | 433 | 434 | [VARIABLES] 435 | 436 | # List of additional names supposed to be defined in builtins. Remember that 437 | # you should avoid defining new builtins when possible. 438 | additional-builtins= 439 | 440 | # Tells whether unused global variables should be treated as a violation. 441 | allow-global-unused-variables=yes 442 | 443 | # List of names allowed to shadow builtins 444 | allowed-redefined-builtins= 445 | 446 | # List of strings which can identify a callback function by name. A callback 447 | # name must start or end with one of those strings. 448 | callbacks=cb_, 449 | _cb 450 | 451 | # A regular expression matching the name of dummy variables (i.e. expected to 452 | # not be used). 453 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ 454 | 455 | # Argument names that match this expression will be ignored. Default to name 456 | # with leading underscore. 457 | ignored-argument-names=_.*|^ignored_|^unused_ 458 | 459 | # Tells whether we should check for unused import in __init__ files. 460 | init-import=no 461 | 462 | # List of qualified module names which can have objects that can redefine 463 | # builtins. 464 | redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io 465 | 466 | 467 | [LOGGING] 468 | 469 | # The type of string formatting that logging methods do. `old` means using % 470 | # formatting, `new` is for `{}` formatting. 471 | logging-format-style=old 472 | 473 | # Logging modules to check that the string format arguments are in logging 474 | # function parameter format. 475 | logging-modules=logging 476 | 477 | 478 | [SPELLING] 479 | 480 | # Limits count of emitted suggestions for spelling mistakes. 481 | max-spelling-suggestions=4 482 | 483 | # Spelling dictionary name. Available dictionaries: none. To make it work, 484 | # install the 'python-enchant' package. 485 | spelling-dict= 486 | 487 | # List of comma separated words that should be considered directives if they 488 | # appear and the beginning of a comment and should not be checked. 489 | spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy: 490 | 491 | # List of comma separated words that should not be checked. 492 | spelling-ignore-words= 493 | 494 | # A path to a file that contains the private dictionary; one word per line. 495 | spelling-private-dict-file= 496 | 497 | # Tells whether to store unknown words to the private dictionary (see the 498 | # --spelling-private-dict-file option) instead of raising a message. 499 | spelling-store-unknown-words=no 500 | 501 | 502 | [CLASSES] 503 | 504 | # Warn about protected attribute access inside special methods 505 | check-protected-access-in-special-methods=no 506 | 507 | # List of method names used to declare (i.e. assign) instance attributes. 508 | defining-attr-methods=__init__, 509 | __new__, 510 | setUp, 511 | __post_init__ 512 | 513 | # List of member names, which should be excluded from the protected access 514 | # warning. 515 | exclude-protected=_asdict, 516 | _fields, 517 | _replace, 518 | _source, 519 | _make 520 | 521 | # List of valid names for the first argument in a class method. 522 | valid-classmethod-first-arg=cls 523 | 524 | # List of valid names for the first argument in a metaclass class method. 525 | valid-metaclass-classmethod-first-arg=cls 526 | 527 | 528 | [DESIGN] 529 | 530 | # Maximum number of arguments for function / method. 531 | max-args=5 532 | 533 | # Maximum number of attributes for a class (see R0902). 534 | max-attributes=7 535 | 536 | # Maximum number of boolean expressions in an if statement (see R0916). 537 | max-bool-expr=5 538 | 539 | # Maximum number of branch for function / method body. 540 | max-branches=12 541 | 542 | # Maximum number of locals for function / method body. 543 | max-locals=15 544 | 545 | # Maximum number of parents for a class (see R0901). 546 | max-parents=7 547 | 548 | # Maximum number of public methods for a class (see R0904). 549 | max-public-methods=20 550 | 551 | # Maximum number of return / yield for function / method body. 552 | max-returns=6 553 | 554 | # Maximum number of statements in function / method body. 555 | max-statements=50 556 | 557 | # Minimum number of public methods for a class (see R0903). 558 | min-public-methods=2 559 | 560 | 561 | [IMPORTS] 562 | 563 | # List of modules that can be imported at any level, not just the top level 564 | # one. 565 | allow-any-import-level= 566 | 567 | # Allow wildcard imports from modules that define __all__. 568 | allow-wildcard-with-all=no 569 | 570 | # Analyse import fallback blocks. This can be used to support both Python 2 and 571 | # 3 compatible code, which means that the block might have code that exists 572 | # only in one or another interpreter, leading to false positives when analysed. 573 | analyse-fallback-blocks=no 574 | 575 | # Deprecated modules which should not be used, separated by a comma. 576 | deprecated-modules=optparse,tkinter.tix 577 | 578 | # Output a graph (.gv or any supported image format) of external dependencies 579 | # to the given file (report RP0402 must not be disabled). 580 | ext-import-graph= 581 | 582 | # Output a graph (.gv or any supported image format) of all (i.e. internal and 583 | # external) dependencies to the given file (report RP0402 must not be 584 | # disabled). 585 | import-graph= 586 | 587 | # Output a graph (.gv or any supported image format) of internal dependencies 588 | # to the given file (report RP0402 must not be disabled). 589 | int-import-graph= 590 | 591 | # Force import order to recognize a module as part of the standard 592 | # compatibility libraries. 593 | known-standard-library= 594 | 595 | # Force import order to recognize a module as part of a third party library. 596 | known-third-party=enchant 597 | 598 | # Couples of modules and preferred modules, separated by a comma. 599 | preferred-modules= 600 | 601 | 602 | [EXCEPTIONS] 603 | 604 | # Exceptions that will emit a warning when being caught. Defaults to 605 | # "BaseException, Exception". 606 | overgeneral-exceptions=builtins.BaseException, 607 | builtins.Exception 608 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /Pipfile: -------------------------------------------------------------------------------- 1 | [[source]] 2 | url = "https://pypi.org/simple" 3 | verify_ssl = true 4 | name = "pypi" 5 | 6 | [packages] 7 | requests = "*" 8 | click = "*" 9 | 10 | [dev-packages] 11 | pytest = "*" 12 | black = "*" 13 | pylint = "*" 14 | twine = "*" 15 | build = "*" 16 | 17 | [scripts] 18 | alarmpy = "python alarmpy/alarmpy.py" 19 | format = "black alarmpy" 20 | formatcheck = "black --check alarmpy" 21 | lint = "pylint -j 0 -d R,C alarmpy" 22 | test = "pytest" 23 | build = "python -m build" 24 | upload = "twine upload dist/*" 25 | clean = "rm -rf build/ dist/ alarmpy.egg-info" 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # 🚨 Pikud Ha'oref Alarm Tracking 2 | 3 | [![Build](https://github.com/yuvadm/alarmpy/workflows/Build/badge.svg)](https://github.com/yuvadm/alarmpy/actions/workflows/build.yml) 4 | [![PyPI](https://img.shields.io/pypi/v/alarmpy)](https://pypi.org/project/alarmpy/) 5 | 6 | A simple CLI tool for tracking Pikud Ha'oref alarms. 7 | 8 | Polls the unofficial API endpoint every second for incoming alarms. Prints active alarms as they occur. Prints routine messages once every 5 minutes by default. 9 | 10 | ![example.png](example.png) 11 | 12 | ## ⚠️ Disclaimer ⚠️ 13 | 14 | This tool is based on an unofficial API, and cannot be guaranteed to show correct or timely data. **Do not** use it if human life is at stake. **Do not** assume it shows you correct data. **Do not** assume it works properly, or even works at all. Always follow official guidelines and procedures published by [Pikud Ha'oref](https://www.oref.org.il/). 15 | 16 | Further fine-print covering the terms of use of this tool can be found in the [GPLv3 license](LICENSE) file. 17 | 18 | ## Install 19 | 20 | ### Pip 21 | 22 | The easiest way to install is from PyPI with `pip`: 23 | 24 | ```bash 25 | $ pip install alarmpy 26 | ``` 27 | 28 | You can then run the `alarmpy` executable directly: 29 | 30 | ```bash 31 | $ alarmpy --help 32 | ``` 33 | 34 | ### Pipenv 35 | 36 | For development usage it's recommended to clone the git repo and use `pipenv`: 37 | 38 | ```bash 39 | $ git clone https://github.com/yuvadm/alarmpy 40 | $ cd alarmpy 41 | $ pipenv install -d 42 | $ pipenv run alarmpy 43 | ``` 44 | 45 | ## Usage 46 | 47 | For the default usage after installation, just run: 48 | 49 | ```bash 50 | $ alarmpy 51 | ``` 52 | 53 | ### Display 54 | 55 | - Set the output language using `--language [en|he|ar|ru]`, this uses the official city and area name translations for Hebrew, Arabic, English and Russian. 56 | - In case of RTL issues in the terminal use `--reverse` to output all names in reverse. 57 | - Use `--highlight abc` in order to highlight any alarm which contains the string `abc`. 58 | 59 | ### Proxy and Mirror Servers 60 | 61 | The unofficial API is limited for use for Israeli-originating IPs only. In order to use alarmpy from outside Israel, users must route traffic through an Israeli exit point. The `HTTPS_PROXY` environment variable is supported for this use case. 62 | 63 | Alternatively, a well-known mirror URL can be used: 64 | 65 | ```bash 66 | $ alarmpy --mirror http://alarmpy.yuv.al/alerts.json 67 | ``` 68 | 69 | ### Advanced 70 | 71 | Advanced flags can be set as described in the usage: 72 | 73 | ```bash 74 | $ pipenv run alarmpy --help 75 | Usage: alarmpy.py [OPTIONS] 76 | 77 | Options: 78 | --language [en|he|ar|ru] Alert language 79 | --highlight TEXT String to search for and highlight in case of 80 | alarm 81 | --reverse Reverse Hebrew/Arabic output for terminals with 82 | RTL bugs 83 | --polling-delay INTEGER Polling delay in seconds 84 | --routine-delay INTEGER Routine message delay in seconds 85 | --alarm-id Print alarm IDs 86 | --repeat-alarms Do not suppress ongoing alarms 87 | --quiet Print only active alarms 88 | --desktop-notifications Create push notifications on your desktop 89 | notification center (currently only in Mac OS) 90 | --mqtt-server TEXT Hostname / IP of MQTT server (optional) 91 | --mqtt-client-id TEXT MQTT client identifier 92 | --mqtt-port INTEGER Port for MQTT server 93 | --mqtt-topic TEXT Topic on which to send MQTT messages 94 | --mqtt-filter TEXT Payload value to filter before sending as a 95 | message (semicolon separated) 96 | --output-test Print a debug output and exit 97 | --help Show this message and exit. 98 | ``` 99 | 100 | ### MQTT Notifications 101 | 102 | Integration with an MQTT server provides the ability to send custom MQTT messages for all or some of the alerts that are received. MQTT requires [`paho-mqtt`](https://pypi.org/project/paho-mqtt/) to be installed separately as an optional dependency. 103 | 104 | To enable, specify at least the following parameters via the command line: 105 | 106 | - `mqtt-server` - The MQTT Server hostname or IP, e.g. `localhost` 107 | - `mqtt-topic` - The MQTT topic to which the MQTT message will be sent, e.g. `alarmpy/zone` 108 | 109 | Additional optional parameters for MQTT integration are: 110 | 111 | - `mqtt-client-id` - The ID of the MQTT client used by alarmpy. This will be used to connect to the MQTT server. Default: `alarmPyClient`. This only needs to be change in case you plan to have more than one instance of alarmpy running 112 | - `mqtt-port` - The port on which the MQTT server is listening to. Default: `1883` 113 | 114 | #### Filtering 115 | 116 | When MQTT is enabled, all alerts are sent as separate messages on the specified topic. In case there is a desire to include only specific alert, use the `mqtt-filter` parameter to provide a semicolon separated list of substrings enclosed in double quotes. Each alert city and area will be checked against all filters, and only when a match is found, will an MQTT message be sent. For example: `--mqtt-filter "gaza;negev"`. 117 | 118 | ## License 119 | 120 | [GPLv3](LICENSE) 121 | -------------------------------------------------------------------------------- /alarmpy/__init__.py: -------------------------------------------------------------------------------- 1 | from .alarmpy import cli 2 | -------------------------------------------------------------------------------- /alarmpy/alarmpy.py: -------------------------------------------------------------------------------- 1 | import click 2 | import json 3 | import os 4 | import requests 5 | import random 6 | 7 | from collections import defaultdict 8 | from datetime import datetime 9 | from pathlib import Path 10 | from time import sleep, time 11 | 12 | try: 13 | import paho.mqtt.client as mqtt 14 | except ImportError: 15 | pass 16 | 17 | 18 | class Alarm: 19 | URL = "https://www.oref.org.il/WarningMessages/alert/alerts.json" 20 | 21 | HEADERS = { 22 | "Referer": "https://www.oref.org.il/11226-he/pakar.aspx", 23 | "X-Requested-With": "XMLHttpRequest", 24 | "User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_13_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/75.0.3770.100 Safari/537.36", 25 | } 26 | 27 | def __init__( 28 | self, 29 | language="he", 30 | highlight=None, 31 | reverse=False, 32 | mirror="", 33 | polling_delay=1, 34 | routine_delay=60 * 5, 35 | alarm_id=False, 36 | repeat_alarms=False, 37 | quiet=False, 38 | desktop_notifications=False, 39 | mqtt_server="", 40 | mqtt_client_id="alarmPyClient", 41 | mqtt_port=1883, 42 | mqtt_topic="", 43 | mqtt_filter=None, 44 | **_kwargs, 45 | ): 46 | self.url = mirror or self.URL 47 | self.language = language 48 | self.highlight = highlight 49 | self.reverse = reverse 50 | self.polling_delay = polling_delay 51 | self.last_routine_delay = routine_delay 52 | self.alarm_id = alarm_id 53 | self.repeat_alarms = repeat_alarms 54 | self.quiet = quiet 55 | self.desktop_notifications = desktop_notifications 56 | 57 | self.mqtt_server = mqtt_server 58 | self.mqtt_client_id = mqtt_client_id 59 | self.mqtt_port = mqtt_port 60 | self.mqtt_topic = mqtt_topic 61 | self.mqtt_filter = mqtt_filter 62 | 63 | self.current_alarms = [] 64 | self.last_routine_output = 0 65 | 66 | self.session = self.init_session() 67 | self.labels = self.load_labels() 68 | 69 | self.init_desktop_notifications() 70 | self.init_mqtt() 71 | 72 | def init_session(self): 73 | return requests.Session() 74 | 75 | def init_desktop_notifications(self): 76 | if self.desktop_notifications: 77 | if os.path.exists("/usr/bin/notify-send"): 78 | self.desktop_notifications = "linux" 79 | elif os.path.exists("/usr/bin/osascript"): 80 | self.desktop_notifications = "osx" 81 | else: 82 | self.output_error( 83 | "Desktop notifications are currently only available for Linux and MacOS" 84 | ) 85 | self.desktop_notifications = False 86 | 87 | def init_mqtt(self): 88 | try: 89 | self.mqtt = mqtt.Client(self.mqtt_client_id) 90 | except NameError: 91 | self.mqtt = None 92 | 93 | self.filters = None 94 | if self.mqtt_server and self.mqtt: 95 | if not self.mqtt: 96 | self.output_error( 97 | "MQTT support cannot be instantiated without the paho-mqtt library installed" 98 | ) 99 | self.mqtt.connect(self.mqtt_server, self.mqtt_port) 100 | self.mqtt.loop_start() 101 | if self.mqtt_filter: 102 | self.filters = self.mqtt_filter.lower().split(";") 103 | 104 | def load_labels(self): 105 | DATA_DIR = Path(__file__).parent / "data" 106 | with open(DATA_DIR / "labels.json", "r", encoding="utf-8") as f: 107 | return json.load(f) 108 | 109 | def start(self): 110 | while True: 111 | try: 112 | res = self.fetch() 113 | cities, alarm_id = self.parse(res) 114 | self.update(cities, alarm_id) 115 | except Exception as e: # pylint: disable=broad-except 116 | self.output_error(f"Exception: {e}") 117 | finally: 118 | sleep(self.polling_delay) 119 | 120 | def fetch(self): 121 | try: 122 | res = self.session.get(self.url, headers=self.HEADERS, timeout=1) 123 | if not res.ok: 124 | if "Access Denied" in res.text: 125 | self.output_error( 126 | "API endpoint has denied access. This might be due to geolocation limitations, please try running from an Israeli-based IP or proxy, or use the --mirror flag" 127 | ) 128 | exit(1) 129 | else: 130 | raise Exception("HTTP request has failed") 131 | return res.content 132 | except requests.Timeout as e: 133 | raise Exception("HTTP request timed out") from e 134 | 135 | def parse(self, res): 136 | if not res: 137 | # empty content means no alarms 138 | return [], None 139 | 140 | if res == b"\xef\xbb\xbf\r\n": 141 | # some weird binary content that also means no alarms 142 | return [], None 143 | 144 | data = {} # To avoid warning in KeyError 145 | try: 146 | data = json.loads(res[3:-2]) # strip leading and trailing bytes 147 | alarm_id = data["id"] 148 | cities = data["data"] 149 | return cities, alarm_id 150 | except ValueError as ve: 151 | raise Exception(f"Error parsing JSON: {res.content}") from ve 152 | except KeyError as ke: 153 | raise Exception(f"Missing keys in JSON data: {data}") from ke 154 | 155 | def update(self, cities, alarm_id): 156 | if cities: 157 | self.update_alarm(cities, alarm_id) 158 | else: 159 | self.update_routine() 160 | 161 | def update_alarm(self, cities, alarm_id): 162 | if self.repeat_alarms or set(cities) != set(self.current_alarms): 163 | self.output_alarms(cities, alarm_id) 164 | self.notify_alarms(cities) 165 | self.current_alarms = cities 166 | 167 | def update_routine(self): 168 | now = time() 169 | if ( 170 | self.current_alarms 171 | or now - self.last_routine_output > self.last_routine_delay 172 | ): 173 | self.output_routine() 174 | self.last_routine_output = now 175 | self.current_alarms = [] 176 | 177 | def output_leading_timestamp(self, nl=False): 178 | now = datetime.now() 179 | ts = now.strftime("%Y-%m-%d %H:%M:%S") 180 | click.secho(f"{ts} ", nl=nl) 181 | 182 | def output_error(self, err): 183 | if not self.quiet: 184 | self.output_leading_timestamp() 185 | click.secho(err, fg="yellow") 186 | 187 | def output_routine(self): 188 | if not self.quiet: 189 | self.output_leading_timestamp() 190 | click.secho("No active alarms", fg="green") 191 | 192 | def output_alarms(self, cities, alarm_id): 193 | areas = self.group_areas_and_localize(cities) 194 | self.output_leading_timestamp(nl=True) 195 | for area, cities in sorted(areas.items()): 196 | bg = "yellow" if self.highlight and self.highlight in area else None 197 | click.secho(f"\t{area:<20} ", fg="red", bg=bg, bold=True, nl=False) 198 | click.secho("\t", nl=False) 199 | for i, city in enumerate(cities): 200 | bg = "yellow" if self.highlight and self.highlight in city else None 201 | click.secho(f"{city}", fg="red", bg=bg, nl=False) 202 | suffix = ", " if i < len(cities) - 1 else "" 203 | click.secho(f"{suffix}", fg="red", nl=False) 204 | click.secho("") 205 | if self.desktop_notifications: 206 | areas_str = "\U0001f6a8" + ", ".join(areas.keys()) 207 | if self.desktop_notifications == "osx": 208 | os.system( 209 | f'/usr/bin/osascript -e \'display notification "{areas_str}" with title "Alarmpy"\'' 210 | ) 211 | else: 212 | os.system(f'/usr/bin/notify-send "{areas_str}"') 213 | if self.alarm_id: 214 | click.secho(f"({alarm_id})") 215 | 216 | def notify_alarms(self, cities): 217 | if self.mqtt_server and self.mqtt_topic: 218 | for city in cities: 219 | labels = self.labels.get(city, {}) 220 | area = labels.get(f"areaname_{self.language}", "") 221 | label = labels.get(f"label_{self.language}", city) 222 | if self.filters is None or self.check_filter(label, area): 223 | self.mqtt.publish(self.mqtt_topic, label) 224 | 225 | def check_filter(self, city, area): 226 | for flt in self.filters: 227 | if flt in city.lower() or flt in area.lower(): 228 | return True 229 | return False 230 | 231 | def group_areas_and_localize(self, cities): 232 | res = defaultdict(list) 233 | for city in cities: 234 | labels = self.labels.get(city, {}) 235 | area = labels.get(f"areaname_{self.language}", "") 236 | label = labels.get(f"label_{self.language}", city) 237 | if self.reverse: 238 | area = area[::-1] 239 | label = label[::-1] 240 | res[area].append(label) 241 | return res 242 | 243 | def output_test(self): 244 | self.output_error("Output test started...") 245 | self.output_routine() 246 | alarms = random.sample(list(self.labels.keys()), 8) 247 | self.output_alarms(alarms, 9999) 248 | self.output_routine() 249 | self.highlight = "ה" if self.language == "he" else "s" 250 | alarms = random.sample(list(self.labels.keys()), 10) 251 | self.output_alarms(alarms, 9999) 252 | self.output_routine() 253 | self.output_routine() 254 | self.output_error("Output test complete, exiting.") 255 | 256 | 257 | @click.command() 258 | @click.option( 259 | "--language", 260 | default="he", 261 | type=click.Choice(["en", "he", "ar", "ru"]), 262 | help="Alert language", 263 | ) 264 | @click.option( 265 | "--highlight", 266 | help="String to search for and highlight in case of alarm", 267 | ) 268 | @click.option( 269 | "--reverse", 270 | is_flag=True, 271 | help="Reverse Hebrew/Arabic output for terminals with RTL bugs", 272 | ) 273 | @click.option("--mirror", default="", help="A mirror host for fetching events") 274 | @click.option("--polling-delay", default=1, help="Polling delay in seconds") 275 | @click.option( 276 | "--routine-delay", default=60 * 5, help="Routine message delay in seconds" 277 | ) 278 | @click.option("--alarm-id", is_flag=True, help="Print alarm IDs") 279 | @click.option("--repeat-alarms", is_flag=True, help="Do not suppress ongoing alarms") 280 | @click.option("--quiet", is_flag=True, help="Print only active alarms") 281 | @click.option( 282 | "--desktop-notifications", 283 | is_flag=True, 284 | help="Create push notifications on your desktop notification center (currently only in Mac OS)", 285 | ) 286 | @click.option( 287 | "--mqtt-server", default=None, help="Hostname / IP of MQTT server (optional)" 288 | ) 289 | @click.option( 290 | "--mqtt-client-id", default="alarmPyClient", help="MQTT client identifier" 291 | ) 292 | @click.option("--mqtt-port", default=1883, help="Port for MQTT server") 293 | @click.option("--mqtt-topic", default=None, help="Topic on which to send MQTT messages") 294 | @click.option( 295 | "--mqtt-filter", 296 | default=None, 297 | help="Payload value to filter before sending as a message (semicolon separated)", 298 | ) 299 | @click.option( 300 | "--output-test", 301 | is_flag=True, 302 | help="Print a debug output and exit", 303 | ) 304 | def cli(**kwargs): 305 | alarm = Alarm(**kwargs) 306 | if kwargs["output_test"]: 307 | alarm.output_test() 308 | else: 309 | alarm.start() 310 | 311 | 312 | if __name__ == "__main__": 313 | cli() 314 | -------------------------------------------------------------------------------- /alarmpy/tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yuvadm/alarmpy/86f3551e48a4c01b7ca3218f6145b5a55a969cdd/alarmpy/tests/__init__.py -------------------------------------------------------------------------------- /alarmpy/tests/test_alarmpy.py: -------------------------------------------------------------------------------- 1 | from ..alarmpy import Alarm 2 | 3 | 4 | def test_parse(): 5 | alarm = Alarm() 6 | res = b'\xef\xbb\xbf{\r\n "id": "132949694460000000",\r\n "cat": "1",\r\n "title": "\xd7\x99\xd7\xa8\xd7\x99 \xd7\x98\xd7\x99\xd7\x9c\xd7\x99\xd7\x9d \xd7\x95\xd7\xa8\xd7\xa7\xd7\x98\xd7\x95\xd7\xaa",\r\n "data": [\r\n "\xd7\xa9\xd7\x93\xd7\xa8\xd7\x95\xd7\xaa, \xd7\x90\xd7\x99\xd7\x91\xd7\x99\xd7\x9d, \xd7\xa0\xd7\x99\xd7\xa8 \xd7\xa2\xd7\x9d",\r\n "\xd7\x90\xd7\xa8\xd7\x96",\r\n "\xd7\x9e\xd7\xa4\xd7\x9c\xd7\xa1\xd7\x99\xd7\x9d",\r\n "\xd7\x9e\xd7\x98\xd7\x95\xd7\x95\xd7\x97 \xd7\xa0\xd7\x99\xd7\xa8 \xd7\xa2\xd7\x9d"\r\n ],\r\n "desc": "\xd7\x94\xd7\x99\xd7\x9b\xd7\xa0\xd7\xa1\xd7\x95 \xd7\x9c\xd7\x9e\xd7\xa8\xd7\x97\xd7\x91 \xd7\x94\xd7\x9e\xd7\x95\xd7\x92\xd7\x9f"\r\n}\r\n' 7 | assert alarm.parse(res) == ( 8 | ["שדרות, איבים, ניר עם", "ארז", "מפלסים", "מטווח ניר עם"], 9 | "132949694460000000", 10 | ) 11 | 12 | 13 | def test_empty_parse(): 14 | alarm = Alarm() 15 | assert alarm.parse(None) == ([], None) 16 | assert alarm.parse(b"") == ([], None) 17 | -------------------------------------------------------------------------------- /example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yuvadm/alarmpy/86f3551e48a4c01b7ca3218f6145b5a55a969cdd/example.png -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import setuptools 2 | 3 | with open("README.md", "r", encoding="utf-8") as fh: 4 | long_description = fh.read() 5 | 6 | setuptools.setup( 7 | name="alarmpy", 8 | version="1.6.0", 9 | author="Yuval Adam", 10 | author_email="_@yuv.al", 11 | description="Pikud Ha'oref Alarm Tracking", 12 | license="GPLv3", 13 | long_description=long_description, 14 | long_description_content_type="text/markdown", 15 | url="https://github.com/yuvadm/alarmpy", 16 | project_urls={ 17 | "Bug Tracker": "https://github.com/yuvadm/alarmpy/issues", 18 | }, 19 | classifiers=[ 20 | "Programming Language :: Python :: 3", 21 | "Development Status :: 5 - Production/Stable", 22 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", 23 | "Operating System :: OS Independent", 24 | "Environment :: Console", 25 | ], 26 | packages=setuptools.find_packages(exclude="tests"), 27 | package_data={"alarmpy": ["data/*.json"]}, 28 | python_requires=">=3.6", 29 | install_requires=["requests", "click"], 30 | extras_require={ 31 | "mqttnotify": ["paho-mqtt"], 32 | }, 33 | entry_points={ 34 | "console_scripts": [ 35 | "alarmpy = alarmpy:cli", 36 | "alarmpynotify = alarmpy:cli [mqttnotify]", 37 | ] 38 | }, 39 | ) 40 | --------------------------------------------------------------------------------