PomCli 0.1.0__tar.gz → 0.2.0__tar.gz

pomcli-0.2.0/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+## [0.2.0] - 2025-06-28
+### Added
+- Support for multiple Pomodoro repetitions via the `--repetitions` CLI option.
+- Optional progress bar display using `tqdm` with the `--tqdm` CLI flag.
+
+## [0.1.0] - 2025-06-28
+### Added
+- Initial release: basic Pomodoro timer CLI with work and break durations.
+lo

{pomcli-0.1.0 → pomcli-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: PomCli
-Version: 0.1.0
+Version: 0.2.0
 Summary: A simple Pomodoro timer CLI tool.
 Project-URL: Documentation, https://github.com/YanivGrosskopf/PomCli#readme
 Project-URL: Issues, https://github.com/YanivGrosskopf/PomCli/issues
@@ -18,6 +18,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
+Requires-Dist: tqdm>=4.0.0
 Description-Content-Type: text/markdown
 
 # PomCli
@@ -49,6 +50,7 @@ pomcli --work 25 --break_time 5
 
 - `--work`: Work duration in minutes (default: 25)
 - `--break_time`: Break duration in minutes (default: 5)
+- `--repetitions`: Number of repetitions (default: 1)
 
 ## License
 

{pomcli-0.1.0 → pomcli-0.2.0}/README.md

@@ -27,6 +27,7 @@ pomcli --work 25 --break_time 5
 
 - `--work`: Work duration in minutes (default: 25)
 - `--break_time`: Break duration in minutes (default: 5)
+- `--repetitions`: Number of repetitions (default: 1)
 
 ## License
 

pomcli-0.2.0/pomodoro_example.py

@@ -0,0 +1,4 @@
+from pomcli.pomodoro import PomodoroTimer
+
+if __name__ == "__main__":
+    PomodoroTimer(work_minutes=0.1, break_minutes=0.05, repetitions=2, use_tqdm=True).start()  # Short times for demo

{pomcli-0.1.0 → pomcli-0.2.0}/pyproject.toml

@@ -24,7 +24,9 @@ classifiers = [
   "Programming Language :: Python :: Implementation :: CPython",
   "Programming Language :: Python :: Implementation :: PyPy",
 ]
-dependencies = []
+dependencies = [
+  "tqdm>=4.0.0"
+]
 
 [project.urls]
 Documentation = "https://github.com/YanivGrosskopf/PomCli#readme"

{pomcli-0.1.0 → pomcli-0.2.0}/src/pomcli/__about__.py

@@ -1,3 +1,2 @@
 # __about__.py for PomCli
-__version__ = "0.1.0"
-
+__version__ = "0.2.0"

pomcli-0.2.0/src/pomcli/pomodoro.py

@@ -0,0 +1,79 @@
+import logging
+import time
+
+
+class PomodoroTimer:
+    def __init__(self, work_minutes=25, break_minutes=5, repetitions=1, logger=None, use_tqdm=False):
+        """
+        Initializes the Pomodoro timer.
+        :param work_minutes: Work duration in minutes.
+        :param break_minutes: Break duration in minutes.
+        :param repetitions: Number of Pomodoro repetitions.
+        :param logger: Logger instance for logging messages. If None, a default logger is created.
+        :param use_tqdm: Whether to use tqdm for progress bar display.
+        """
+        self.work_minutes = work_minutes
+        self.break_minutes = break_minutes
+        self.repetitions = repetitions
+        self.is_running = False
+        if logger is None:
+            logging.basicConfig(level=logging.INFO, format='%(levelname)s:%(message)s')
+        self.logger = logger or logging.getLogger(__name__)
+
+        self.use_tqdm = use_tqdm
+
+    def start(self):
+        """
+        Starts the Pomodoro timer.
+        """
+        self.is_running = True
+        for i in range(self.repetitions):
+            self.logger.info(f"Pomodoro round {i + 1} of {self.repetitions}")
+            self.logger.info(f"Starting Pomodoro: {self.work_minutes} minutes of work.")
+            self._countdown(self.work_minutes * 60, "Work")
+            if i < self.repetitions - 1:
+                self.logger.info(f"Time for a break: {self.break_minutes} minutes.")
+        self.logger.info("Pomodoro session complete!")
+        self.is_running = False
+
+    def _countdown(self, seconds, label):
+        if self.use_tqdm:
+            try:
+                from tqdm import tqdm
+            except ImportError:
+                self.logger.warning("tqdm is not installed. Progress bar will not be shown.")
+                tqdm = None
+        else:
+            tqdm = None
+        seconds = int(seconds)
+        iterator = tqdm(range(seconds), desc=f"{label} Timer",
+                        ncols=70) if self.use_tqdm and 'tqdm' in locals() and tqdm else range(seconds)
+        for s in iterator:
+            if not self.is_running:
+                break
+            mins, secs = divmod(int(seconds - s - 1), 60)
+            timeformat = f'{mins:02d}:{secs:02d}'
+            self.logger.debug(f'{label} Timer: {timeformat}')
+            time.sleep(1)
+
+    def stop(self):
+        self.is_running = False
+        self.logger.info("Pomodoro stopped.")
+
+
+def main():
+    import argparse
+    logging.basicConfig(level=logging.INFO, format='%(message)s')
+    parser = argparse.ArgumentParser(description="Simple Pomodoro CLI Timer")
+    parser.add_argument('--work', type=float, default=25, help='Work duration in minutes (default: 25)')
+    parser.add_argument('--break_time', type=float, default=5, help='Break duration in minutes (default: 5)')
+    parser.add_argument('--repetitions', type=int, default=1, help='Number of Pomodoro repetitions (default: 1)')
+    parser.add_argument('--tqdm', action='store_true', help='Show progress bar using tqdm')
+    args = parser.parse_args()
+    timer = PomodoroTimer(work_minutes=args.work, break_minutes=args.break_time, repetitions=args.repetitions,
+                          use_tqdm=args.tqdm)
+    timer.start()
+
+
+if __name__ == "__main__":
+    main()

{pomcli-0.1.0 → pomcli-0.2.0}/tests/test_pomodoro.py

@@ -1,8 +1,10 @@
-import unittest
-import time
 import logging
+import time
+import unittest
+
 from pomcli.pomodoro import PomodoroTimer
 
+
 class TestPomodoroTimer(unittest.TestCase):
     def setUp(self):
         self.logger = logging.getLogger("pomodoro_test")
@@ -15,17 +17,19 @@ class TestPomodoroTimer(unittest.TestCase):
     class _LogCapture:
         def __init__(self, output_list):
             self.output_list = output_list
+
         def write(self, msg):
             if msg.strip():
                 self.output_list.append(msg.strip())
+
         def flush(self):
             pass
 
     def test_start_and_stop(self):
         timer = PomodoroTimer(work_minutes=0, break_minutes=0, logger=self.logger)
         timer.start()
+        self.assertIn("INFO:Pomodoro round 1 of 1", self.log_output)
         self.assertIn("INFO:Starting Pomodoro: 0 minutes of work.", self.log_output)
-        self.assertIn("INFO:Time for a break: 0 minutes.", self.log_output)
         self.assertIn("INFO:Pomodoro session complete!", self.log_output)
         timer.stop()
         self.assertIn("INFO:Pomodoro stopped.", self.log_output)
@@ -40,6 +44,28 @@ class TestPomodoroTimer(unittest.TestCase):
         t.join()
         self.assertIn("INFO:Pomodoro stopped.", self.log_output)
 
+    def test_repetitions(self):
+        timer = PomodoroTimer(work_minutes=0, break_minutes=0, repetitions=3, logger=self.logger)
+        timer.start()
+        rounds = [msg for msg in self.log_output if "Pomodoro round" in msg]
+        self.assertEqual(len(rounds), 3)
+        self.assertIn("INFO:Pomodoro round 1 of 3", rounds[0])
+        self.assertIn("INFO:Pomodoro round 2 of 3", rounds[1])
+        self.assertIn("INFO:Pomodoro round 3 of 3", rounds[2])
+        self.assertIn("INFO:Pomodoro session complete!", self.log_output)
+
+    def test_tqdm_usage(self):
+        try:
+            from tqdm import tqdm
+        except ImportError:
+            self.skipTest("tqdm is not installed, skipping tqdm usage test.")
+
+        timer = PomodoroTimer(work_minutes=0.05, break_minutes=0.05, repetitions=2, use_tqdm=True, logger=self.logger)
+        timer.start()
+        self.assertIn("INFO:Starting Pomodoro: 0.05 minutes of work.", self.log_output)
+        self.assertIn("INFO:Time for a break: 0.05 minutes.", self.log_output)
+        self.assertIn("INFO:Pomodoro session complete!", self.log_output)
+
+
 if __name__ == "__main__":
     unittest.main()
-

pomcli-0.1.0/pomodoro_example.py

@@ -1,5 +0,0 @@
-from pomcli.pomodoro import PomodoroTimer
-
-if __name__ == "__main__":
-    timer = PomodoroTimer(work_minutes=0.1, break_minutes=0.05)  # Short times for demo
-    timer.start()

pomcli-0.1.0/src/pomcli/pomodoro.py

@@ -1,43 +0,0 @@
-import time
-import logging
-
-class PomodoroTimer:
-    def __init__(self, work_minutes=25, break_minutes=5, logger=None):
-        self.work_minutes = work_minutes
-        self.break_minutes = break_minutes
-        self.is_running = False
-        self.logger = logger or logging.getLogger(__name__)
-
-    def start(self):
-        self.is_running = True
-        self.logger.info(f"Starting Pomodoro: {self.work_minutes} minutes of work.")
-        self._countdown(self.work_minutes * 60, "Work")
-        self.logger.info(f"Time for a break: {self.break_minutes} minutes.")
-        self._countdown(self.break_minutes * 60, "Break")
-        self.logger.info("Pomodoro session complete!")
-        self.is_running = False
-
-    def _countdown(self, seconds, label):
-        while seconds > 0 and self.is_running:
-            mins, secs = divmod(int(seconds), 60)
-            timeformat = f'{mins:02d}:{secs:02d}'
-            self.logger.debug(f'{label} Timer: {timeformat}')
-            time.sleep(1)
-            seconds -= 1
-
-    def stop(self):
-        self.is_running = False
-        self.logger.info("Pomodoro stopped.")
-
-def main():
-    import argparse
-    logging.basicConfig(level=logging.INFO, format='%(message)s')
-    parser = argparse.ArgumentParser(description="Simple Pomodoro CLI Timer")
-    parser.add_argument('--work', type=float, default=25, help='Work duration in minutes (default: 25)')
-    parser.add_argument('--break_time', type=float, default=5, help='Break duration in minutes (default: 5)')
-    args = parser.parse_args()
-    timer = PomodoroTimer(work_minutes=args.work, break_minutes=args.break_time)
-    timer.start()
-
-if __name__ == "__main__":
-    main()