aa-killtracker 0.15.0__tar.gz → 0.17.0__tar.gz

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: aa-killtracker
-Version: 0.15.0
-Summary: "An app for running killmail trackers with Alliance Auth and Discord.
+Version: 0.17.0
+Summary: An app for running killmail trackers with Alliance Auth and Discord.
 Author-email: Erik Kalkoken <kalkoken87@gmail.com>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+License-File: LICENSE
 Requires-Dist: allianceauth-app-utils>=1.19.0
 Requires-Dist: allianceauth>=3
 Requires-Dist: dacite
@@ -116,7 +117,7 @@ Add below lines to your settings file:
 # aa-killtracker
 CELERYBEAT_SCHEDULE['killtracker_run_killtracker'] = {
     'task': 'killtracker.tasks.run_killtracker',
-    'schedule': crontab(minute='*/1'),
+    'schedule': 60,
 }
 KILLTRACKER_QUEUE_ID = ""  # Put your unique queue ID here
 ```
@@ -241,7 +242,7 @@ Note that all settings are optional and the app will use the documented default
 Name | Description | Default
 -- | -- | --
 `KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER`| Ignore killmails that are older than the given number in minutes. Sometimes killmails appear belated on ZKB, this feature ensures they don't create new alerts | `60`
-`KILLTRACKER_MAX_KILLMAILS_PER_RUN`| Maximum number of killmails retrieved from ZKB by task run. This value should be set such that the task that fetches new killmails from ZKB every minute will reliable finish within one minute. To test this run a "Catch all" tracker and see how many killmails your system is capable of processing. Note that you can get that information from the worker's log file. It will look something like this: `Total killmails received from ZKB in 49 secs: 251`   | `250`
+`KILLTRACKER_MAX_KILLMAILS_PER_RUN`| Maximum number of killmails retrieved from ZKB by task run. This value should be set such that the task that fetches new killmails from ZKB every minute will reliable finish within one minute. To test this run a "Catch all" tracker and see how many killmails your system is capable of processing. Note that you can get that information from the worker's log file. It will look something like this: `Total killmails received from ZKB in 49 secs: 100`   | `100`
 `KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS`| Killmails older than set number of days will be purged from the database. If you want to keep all killmails set this to 0. Note that this setting is only relevant if you have storing killmails enabled.  | `30`
 `KILLTRACKER_QUEUE_ID`| Unique ID used to identify this server when fetching killmails from zKillboard. This setting is mandatory.  | ``
 `KILLTRACKER_STORING_KILLMAILS_ENABLED`| If set to true Killtracker will automatically store all received killmails in the local database. This can be useful if you want to run analytics on killmails etc. However, please note that Killtracker itself currently does not use stored killmails in any way.  | `False`

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/README.md

@@ -87,7 +87,7 @@ Add below lines to your settings file:
 # aa-killtracker
 CELERYBEAT_SCHEDULE['killtracker_run_killtracker'] = {
     'task': 'killtracker.tasks.run_killtracker',
-    'schedule': crontab(minute='*/1'),
+    'schedule': 60,
 }
 KILLTRACKER_QUEUE_ID = ""  # Put your unique queue ID here
 ```
@@ -212,7 +212,7 @@ Note that all settings are optional and the app will use the documented default
 Name | Description | Default
 -- | -- | --
 `KILLTRACKER_KILLMAIL_MAX_AGE_FOR_TRACKER`| Ignore killmails that are older than the given number in minutes. Sometimes killmails appear belated on ZKB, this feature ensures they don't create new alerts | `60`
-`KILLTRACKER_MAX_KILLMAILS_PER_RUN`| Maximum number of killmails retrieved from ZKB by task run. This value should be set such that the task that fetches new killmails from ZKB every minute will reliable finish within one minute. To test this run a "Catch all" tracker and see how many killmails your system is capable of processing. Note that you can get that information from the worker's log file. It will look something like this: `Total killmails received from ZKB in 49 secs: 251`   | `250`
+`KILLTRACKER_MAX_KILLMAILS_PER_RUN`| Maximum number of killmails retrieved from ZKB by task run. This value should be set such that the task that fetches new killmails from ZKB every minute will reliable finish within one minute. To test this run a "Catch all" tracker and see how many killmails your system is capable of processing. Note that you can get that information from the worker's log file. It will look something like this: `Total killmails received from ZKB in 49 secs: 100`   | `100`
 `KILLTRACKER_PURGE_KILLMAILS_AFTER_DAYS`| Killmails older than set number of days will be purged from the database. If you want to keep all killmails set this to 0. Note that this setting is only relevant if you have storing killmails enabled.  | `30`
 `KILLTRACKER_QUEUE_ID`| Unique ID used to identify this server when fetching killmails from zKillboard. This setting is mandatory.  | ``
 `KILLTRACKER_STORING_KILLMAILS_ENABLED`| If set to true Killtracker will automatically store all received killmails in the local database. This can be useful if you want to run analytics on killmails etc. However, please note that Killtracker itself currently does not use stored killmails in any way.  | `False`

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/killtracker/__init__.py

@@ -1,9 +1,9 @@
-""""An app for running killmail trackers with Alliance Auth and Discord."""
+"""An app for running killmail trackers with Alliance Auth and Discord."""
 
 # pylint: disable = invalid-name
 default_app_config = "killtracker.apps.KillmailsConfig"
 
-__version__ = "0.15.0"
+__version__ = "0.17.0"
 __title__ = "Killtracker"
 
 APP_NAME = "aa-killtracker"

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/killtracker/app_settings.py

@@ -14,7 +14,7 @@ this feature ensures they don't create new alerts.
 """
 
 KILLTRACKER_MAX_KILLMAILS_PER_RUN = clean_setting(
-    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", 200
+    "KILLTRACKER_MAX_KILLMAILS_PER_RUN", 100
 )
 """Maximum number of killmails retrieved from ZKB by task run."""
 
@@ -99,3 +99,10 @@ KILLTRACKER_STORAGE_KILLMAILS_LIFETIME = clean_setting(
     "KILLTRACKER_STORAGE_KILLMAILS_LIFETIME", 3_600 * 1
 )
 """Max lifetime of killmails in temporary storage in seconds."""
+
+KILLTRACKER_ZKB_REQUEST_DELAY = clean_setting("KILLTRACKER_ZKB_REQUEST_DELAY", 500)
+"""Delay between subsequent calls to ZKB API in milliseconds.
+
+This delay ensures the app does not breach the CloudFlare rate limit of currently
+two (2) requests per second per IP address.
+"""

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/killtracker/apps.py

@@ -9,6 +9,7 @@ class KillmailsConfig(AppConfig):
     verbose_name = f"Killtracker v{__version__}"
 
     def ready(self) -> None:
+        from . import checks  # noqa: F401 pylint: disable=unused-import
         from .core.killmails import Killmail
 
         Killmail.reset_lock_key()

aa_killtracker-0.17.0/killtracker/checks.py

@@ -0,0 +1,45 @@
+"""Django checks."""
+
+import numbers
+
+from django.conf import settings
+from django.core.checks import Warning as DjangoWarning
+from django.core.checks import register
+
+
+@register()
+def killtracker_config_check(app_configs, **kwargs):  # pylint: disable=W0613
+    """killtracker_config_check is a Django check that verifies that all periodic tasks
+    have been configured correctly in settings.
+    """
+    if not hasattr(settings, "CELERYBEAT_SCHEDULE"):
+        return []
+
+    warnings = []
+    for name, obj in settings.CELERYBEAT_SCHEDULE.items():
+        _verify_task_config(warnings, name, obj, "killtracker.tasks.run_killtracker")
+    return warnings
+
+
+def _verify_task_config(warnings: list, name: str, obj: dict, task_name: str):
+    if obj["task"] != task_name:
+        return
+
+    schedule = obj["schedule"]
+    if isinstance(schedule, numbers.Number):
+        return
+
+    warnings.append(
+        DjangoWarning(
+            (
+                "Periodic task has deprecated schedule: "
+                f'CELERYBEAT_SCHEDULE["{name}"]'
+            ),
+            hint=(
+                'The value for "schedule" must be a positive number, '
+                "not e.g. a cron definition. "
+                f"Current value is: {schedule}"
+            ),
+            id="killtracker.W001",
+        )
+    )

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/killtracker/core/killmails.py

@@ -38,7 +38,7 @@ from killtracker.providers import esi
 
 logger = LoggerAddTag(get_extension_logger(__name__), __title__)
 
-ZKB_REDISQ_URL = "https://redisq.zkillboard.com/listen.php"
+ZKB_REDISQ_URL = "https://zkillredisq.stream/listen.php"
 ZKB_API_URL = "https://zkillboard.com/api/"
 ZKB_KILLMAIL_BASEURL = "https://zkillboard.com/kill/"
 REQUESTS_TIMEOUT = (5, 30)
@@ -97,6 +97,7 @@ class KillmailAttacker(_KillmailCharacter):
 @dataclass
 class KillmailPosition(_KillmailBase):
     "A position for a killmail."
+
     x: Optional[float] = None
     y: Optional[float] = None
     z: Optional[float] = None

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/killtracker/tasks.py

@@ -1,8 +1,11 @@
 """Tasks for killtracker."""
 
+from datetime import timedelta
+
 from celery import chain, shared_task
 
 from django.db import IntegrityError
+from django.utils.timezone import now
 from eveuniverse.core.esitools import is_esi_online
 from eveuniverse.tasks import update_unresolved_eve_entities
 
@@ -22,6 +25,7 @@ from .app_settings import (
     KILLTRACKER_STORING_KILLMAILS_ENABLED,
     KILLTRACKER_TASK_OBJECTS_CACHE_TIMEOUT,
     KILLTRACKER_TASKS_TIMEOUT,
+    KILLTRACKER_ZKB_REQUEST_DELAY,
 )
 from .core.killmails import Killmail
 from .exceptions import WebhookTooManyRequests
@@ -69,7 +73,10 @@ def run_killtracker(runs: int = 0) -> None:
 
     total_killmails = runs + (1 if killmail else 0)
     if killmail and total_killmails < KILLTRACKER_MAX_KILLMAILS_PER_RUN:
-        run_killtracker.delay(runs=runs + 1)
+        run_killtracker.apply_async(
+            kwargs={"runs": runs + 1},
+            eta=now() + timedelta(milliseconds=KILLTRACKER_ZKB_REQUEST_DELAY),
+        )
     else:
         if (
             KILLTRACKER_STORING_KILLMAILS_ENABLED

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/killtracker/tools/generate_conditions_text.py

@@ -1,5 +1,5 @@
 # flake8: noqa
-""" this generated the list of current tracker conditions for the documentation"""
+"""this generated the list of current tracker conditions for the documentation"""
 
 # init and setup django project
 import inspect

{aa_killtracker-0.15.0 → aa_killtracker-0.17.0}/pyproject.toml

@@ -74,4 +74,5 @@ disable = [
     "import-outside-toplevel",
     "imported-auth-user",
     "too-many-instance-attributes",
+    "too-many-positional-arguments",
 ]