taskshooter 0.1.0__tar.gz

taskshooter-0.1.0/PKG-INFO

@@ -0,0 +1,22 @@
+Metadata-Version: 2.1
+Name: taskshooter
+Version: 0.1.0
+Summary: Library to schedule tasks with custom triggers.
+Home-page: https://github.com/fedecalendino/taskshooter
+License: MIT
+Keywords: task,trigger,scheduler
+Author: Fede Calendino
+Author-email: fede@calendino.com
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pytz (>=2024.2,<2025.0)
+Project-URL: Documentation, https://github.com/fedecalendino/taskshooter/blob/main/README.md
+Description-Content-Type: text/markdown
+
+# taskshooter
+

taskshooter-0.1.0/README.md

@@ -0,0 +1 @@
+# taskshooter

taskshooter-0.1.0/pyproject.toml

@@ -0,0 +1,44 @@
+[tool.poetry]
+name = "taskshooter"
+description = "Library to schedule tasks with custom triggers."
+documentation = "https://github.com/fedecalendino/taskshooter/blob/main/README.md"
+homepage = "https://github.com/fedecalendino/taskshooter"
+license = "MIT"
+readme = "README.md"
+version = "0.1.0"
+
+authors = [
+  "Fede Calendino <fede@calendino.com>",
+]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+keywords = [
+    "task",
+    "trigger",
+    "scheduler",
+]
+packages = [
+  { include = "taskshooter" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+pytz = "^2024.2"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.10.0"
+
+
+[tool.poetry.group.test.dependencies]
+ddt = "^1.7.2"
+
+[tool.black]
+line-length = 120
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

taskshooter-0.1.0/taskshooter/__init__.py

@@ -0,0 +1,4 @@
+from . import triggers
+from .scheduler import Scheduler
+from .task import Task
+from .trigger import Trigger, MinuteTrigger, HourTrigger, DayTrigger

taskshooter-0.1.0/taskshooter/scheduler.py

@@ -0,0 +1,38 @@
+import logging
+from threading import Thread
+from time import time, sleep
+
+from .task import Task
+
+logger = logging.getLogger(__name__)
+
+
+class Scheduler:
+    def __init__(self, tasks: list[Task] = None):
+        self.tasks = tasks or []
+
+    def run(self):
+        self.show()
+
+        while True:
+            self.nap()
+            self.workwork()
+
+    def add(self, task: Task):
+        self.tasks.append(task)
+
+    def show(self):
+        logger.info("Scheduled tasks:")
+
+        for task in self.tasks:
+            logger.info(f" * {task.name}: {task.trigger.description}")
+
+    def workwork(self):
+        for task in self.tasks:
+            thread = Thread(target=task.run)
+            thread.start()
+
+    def nap(self):
+        seconds = 60 - time() % 60
+        logger.debug("💤 sleeping")
+        sleep(seconds)

taskshooter-0.1.0/taskshooter/task.py

@@ -0,0 +1,78 @@
+import logging
+from abc import ABC, abstractmethod
+from datetime import datetime
+
+from .trigger import Trigger
+
+logger = logging.getLogger(__name__)
+
+
+class Task(ABC):
+    def __init__(self, name: str, trigger: Trigger, emoji: str = None):
+        self.name: str = name
+        self.emoji: str = emoji
+        self.trigger: Trigger = trigger
+
+        self.stated_at: datetime = None
+        self.finished_at: datetime = None
+
+    @abstractmethod
+    def execute(self):
+        raise NotImplementedError()
+
+    def run(self, force: bool = False, manual: bool = False):
+        if not force:
+            if not self.trigger.check():
+                return
+
+        self.info("running task...")
+
+        self.stated_at = datetime.now()
+        self.pre_run()
+
+        try:
+            self.execute()
+            self.finished_at = datetime.now()
+            self.info(f"completed successfully in {self.runtime}ms")
+
+            self.post_run(manual=manual, exception=None)
+        except Exception as exception:
+            self.exception(exception)
+            self.finished_at = datetime.now()
+
+            self.post_run(manual=manual, exception=exception)
+
+    def pre_run(self):
+        pass
+
+    def post_run(self, manual: bool = False, exception: Exception = None):
+        pass
+
+    @property
+    def is_running(self) -> bool:
+        return bool(self.stated_at and not self.finished_at)
+
+    @property
+    def runtime(self) -> float:
+        if not self.finished_at:
+            return None
+
+        return int((self.finished_at - self.stated_at).microseconds / 1000)
+
+    # logging
+    def log(self, level: int, message: str, exception: Exception = None):
+        if self.emoji:
+            prefix = f"{self.emoji} {self.name}"
+        else:
+            prefix = f"{self.name}"
+
+        logger.log(level, f"%s > %s", prefix, message, exc_info=exception)
+
+    def info(self, message: str):
+        self.log(logging.INFO, message)
+
+    def error(self, message: str):
+        self.log(logging.ERROR, message)
+
+    def exception(self, exception: Exception):
+        self.log(logging.ERROR, str(exception), exception)

taskshooter-0.1.0/taskshooter/trigger.py

@@ -0,0 +1,99 @@
+from abc import ABC, abstractmethod, abstractproperty
+from datetime import datetime
+
+from pytz import BaseTzInfo, UTC
+
+
+class Trigger(ABC):
+    @property
+    @abstractmethod
+    def description(self) -> str:
+        raise NotImplementedError()
+
+    @abstractmethod
+    def check(self) -> bool:
+        raise NotImplementedError()
+
+    def __str__(self) -> str:
+        return self.description
+
+
+class MinuteTrigger(Trigger):
+    def __init__(self, minutes: int, tz: BaseTzInfo = UTC):
+        assert minutes > 0
+
+        self.minutes: int = minutes
+        self.tz: BaseTzInfo = tz
+
+    @property
+    def description(self) -> str:
+        if self.minutes == 1:
+            return "every minute"
+
+        return "every {minutes} minutes".format(
+            minutes=self.minutes,
+        )
+
+    def check(self) -> bool:
+        now = datetime.now(self.tz)
+
+        return now.minute % self.minutes == 0
+
+    def __str__(self) -> str:
+        return self.description
+
+
+class HourTrigger(Trigger):
+    def __init__(self, hours: int, tz: BaseTzInfo = UTC):
+        assert hours > 0
+
+        self.hours: int = hours
+        self.tz: BaseTzInfo = tz
+
+    @property
+    def description(self) -> str:
+        tz = self.tz.zone
+
+        if self.hours == 1:
+            return "every hour (tz={tz})".format(
+                tz=tz,
+            )
+
+        return "every {hours} hours (tz={tz})".format(
+            hours=self.hours,
+            tz=tz,
+        )
+
+    def check(self) -> bool:
+        now = datetime.now(self.tz)
+
+        if now.minute != 0:
+            return False
+
+        return now.hour % self.hours == 0
+
+    def __str__(self) -> str:
+        return self.description
+
+
+class DayTrigger(Trigger):
+    def __init__(self, hour: int, minute: int, tz: BaseTzInfo = UTC):
+        assert 0 <= hour < 24
+        assert 0 <= minute < 60
+
+        self.hour: int = hour
+        self.minute: int = minute
+        self.tz: BaseTzInfo = tz
+
+    @property
+    def description(self) -> str:
+        return "every day @ {hour:02d}:{minute:02d} (tz={tz})".format(
+            hour=self.hour,
+            minute=self.minute,
+            tz=self.tz.zone,
+        )
+
+    def check(self) -> bool:
+        now = datetime.now(self.tz)
+
+        return now.hour == self.hour and now.minute == self.minute

taskshooter-0.1.0/taskshooter/triggers.py

@@ -0,0 +1,24 @@
+from pytz import UTC
+
+from .trigger import MinuteTrigger, HourTrigger, DayTrigger
+
+minutes_1 = MinuteTrigger(1)
+minutes_5 = MinuteTrigger(5)
+minutes_10 = MinuteTrigger(10)
+minutes_15 = MinuteTrigger(15)
+minutes_20 = MinuteTrigger(20)
+minutes_30 = MinuteTrigger(30)
+minutes_60 = MinuteTrigger(60)
+
+hours_1 = HourTrigger(1)
+hours_2 = HourTrigger(2)
+hours_3 = HourTrigger(3)
+hours_6 = HourTrigger(6)
+hours_12 = HourTrigger(12)
+hours_24 = HourTrigger(24)
+
+utc_0000 = DayTrigger(hour=0, minute=0, tz=UTC)
+utc_0600 = DayTrigger(hour=6, minute=0, tz=UTC)
+utc_1200 = DayTrigger(hour=12, minute=0, tz=UTC)
+utc_1800 = DayTrigger(hour=18, minute=0, tz=UTC)
+utc_2359 = DayTrigger(hour=23, minute=59, tz=UTC)