bouquin 0.3.2__tar.gz → 0.4__tar.gz

{bouquin-0.3.2 → bouquin-0.4}/PKG-INFO

@@ -1,15 +1,14 @@
 Metadata-Version: 2.1
 Name: bouquin
-Version: 0.3.2
+Version: 0.4
 Summary: Bouquin is a simple, opinionated notebook application written in Python, PyQt and SQLCipher.
 Home-page: https://git.mig5.net/mig5/bouquin
 License: GPL-3.0-or-later
 Author: Miguel Jacq
 Author-email: mig@mig5.net
-Requires-Python: >=3.9,<3.14
+Requires-Python: >=3.10,<3.14
 Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
@@ -24,7 +23,11 @@ Description-Content-Type: text/markdown
 
 ## Introduction
 
-Bouquin ("Book-ahn") is a simple, opinionated notebook application written in Python, PyQt and SQLCipher.
+Bouquin ("Book-ahn") is a notebook and planner application written in Python, PyQt and SQLCipher.
+
+It is designed to treat each day as its own 'page', complete with Markdown rendering, tagging,
+search, reminders and time logging for those of us who need to keep track of not just TODOs, but
+also how long we spent on them.
 
 It uses [SQLCipher bindings](https://pypi.org/project/sqlcipher3-wheels) as a drop-in replacement
 for SQLite3. This means that the underlying database for the notebook is encrypted at rest.
@@ -37,31 +40,34 @@ report from within the app.
 
 ## Screenshots
 
+### General view
 ![Screenshot of Bouquin](https://git.mig5.net/mig5/bouquin/raw/branch/main/screenshots/screenshot.png)
+
+### History panes
 ![Screenshot of Bouquin History Preview pane](https://git.mig5.net/mig5/bouquin/raw/branch/main/screenshots/history_preview.png)
 ![Screenshot of Bouquin History Diff pane](https://git.mig5.net/mig5/bouquin/raw/branch/main/screenshots/history_diff.png)
 
-## Features
+## Some of the features
 
  * Data is encrypted at rest
  * Encryption key is prompted for and never stored, unless user chooses to via Settings
- * Every 'page' is linked to the calendar day
  * All changes are version controlled, with ability to view/diff versions and revert
- * Text is Markdown with basic styling
+ * Automatic rendering of basic Markdown syntax
  * Tabs are supported - right-click on a date from the calendar to open it in a new tab.
- * Images are supported, as is the ability to take a screenshot and have it insert into the page automatically.
- * Search all pages, or find text on page (Ctrl+F)
- * Add tags to pages, find pages by tag in the Tag Browser, and customise tag names and colours
+ * Images are supported
+ * Search all pages, or find text on current page
+ * Add and manage tags
  * Automatic periodic saving (or explicitly save)
- * Transparent integrity checking of the database when it opens
  * Automatic locking of the app after a period of inactivity (default 15 min)
  * Rekey the database (change the password)
  * Export the database to json, html, csv, markdown or .sql (for sqlite3)
  * Backup the database to encrypted SQLCipher format (which can then be loaded back in to a Bouquin)
- * Dark and light themes
+ * Dark and light theme support
  * Automatically generate checkboxes when typing 'TODO'
  * It is possible to automatically move unchecked checkboxes from yesterday to today, on startup
  * English, French and Italian locales provided
+ * Ability to set reminder alarms in the app against the current line of text on today's date
+ * Ability to log time per day and run timesheet reports
 
 
 ## How to install

{bouquin-0.3.2 → bouquin-0.4}/README.md

@@ -3,7 +3,11 @@
 
 ## Introduction
 
-Bouquin ("Book-ahn") is a simple, opinionated notebook application written in Python, PyQt and SQLCipher.
+Bouquin ("Book-ahn") is a notebook and planner application written in Python, PyQt and SQLCipher.
+
+It is designed to treat each day as its own 'page', complete with Markdown rendering, tagging,
+search, reminders and time logging for those of us who need to keep track of not just TODOs, but
+also how long we spent on them.
 
 It uses [SQLCipher bindings](https://pypi.org/project/sqlcipher3-wheels) as a drop-in replacement
 for SQLite3. This means that the underlying database for the notebook is encrypted at rest.
@@ -16,31 +20,34 @@ report from within the app.
 
 ## Screenshots
 
+### General view
 ![Screenshot of Bouquin](https://git.mig5.net/mig5/bouquin/raw/branch/main/screenshots/screenshot.png)
+
+### History panes
 ![Screenshot of Bouquin History Preview pane](https://git.mig5.net/mig5/bouquin/raw/branch/main/screenshots/history_preview.png)
 ![Screenshot of Bouquin History Diff pane](https://git.mig5.net/mig5/bouquin/raw/branch/main/screenshots/history_diff.png)
 
-## Features
+## Some of the features
 
  * Data is encrypted at rest
  * Encryption key is prompted for and never stored, unless user chooses to via Settings
- * Every 'page' is linked to the calendar day
  * All changes are version controlled, with ability to view/diff versions and revert
- * Text is Markdown with basic styling
+ * Automatic rendering of basic Markdown syntax
  * Tabs are supported - right-click on a date from the calendar to open it in a new tab.
- * Images are supported, as is the ability to take a screenshot and have it insert into the page automatically.
- * Search all pages, or find text on page (Ctrl+F)
- * Add tags to pages, find pages by tag in the Tag Browser, and customise tag names and colours
+ * Images are supported
+ * Search all pages, or find text on current page
+ * Add and manage tags
  * Automatic periodic saving (or explicitly save)
- * Transparent integrity checking of the database when it opens
  * Automatic locking of the app after a period of inactivity (default 15 min)
  * Rekey the database (change the password)
  * Export the database to json, html, csv, markdown or .sql (for sqlite3)
  * Backup the database to encrypted SQLCipher format (which can then be loaded back in to a Bouquin)
- * Dark and light themes
+ * Dark and light theme support
  * Automatically generate checkboxes when typing 'TODO'
  * It is possible to automatically move unchecked checkboxes from yesterday to today, on startup
  * English, French and Italian locales provided
+ * Ability to set reminder alarms in the app against the current line of text on today's date
+ * Ability to log time per day and run timesheet reports
 
 
 ## How to install

{bouquin-0.3.2 → bouquin-0.4}/bouquin/bug_report_dialog.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import importlib.metadata
+
 import requests
 
 from PySide6.QtWidgets import (
@@ -49,6 +50,8 @@ class BugReportDialog(QDialog):
         button_box.rejected.connect(self.reject)
         layout.addWidget(button_box)
 
+        self.setMinimumWidth(560)
+
         self.text_edit.setFocus()
 
     # ------------Helpers ------------ #

{bouquin-0.3.2 → bouquin-0.4}/bouquin/db.py

@@ -17,6 +17,18 @@ from . import strings
 
 Entry = Tuple[str, str]
 TagRow = Tuple[int, str, str]
+ProjectRow = Tuple[int, str]  # (id, name)
+ActivityRow = Tuple[int, str]  # (id, name)
+TimeLogRow = Tuple[
+    int,  # id
+    str,  # page_date (yyyy-MM-dd)
+    int,
+    str,  # project_id, project_name
+    int,
+    str,  # activity_id, activity_name
+    int,  # minutes
+    str | None,  # note
+]
 
 _TAG_COLORS = [
     "#FFB3BA",  # soft red
@@ -148,6 +160,38 @@ class DBManager:
             );
 
             CREATE INDEX IF NOT EXISTS ix_page_tags_tag_id ON page_tags(tag_id);
+
+            CREATE TABLE IF NOT EXISTS projects (
+                id INTEGER PRIMARY KEY,
+                name TEXT NOT NULL UNIQUE
+            );
+
+            CREATE TABLE IF NOT EXISTS activities (
+                id INTEGER PRIMARY KEY,
+                name TEXT NOT NULL UNIQUE
+            );
+
+            CREATE TABLE IF NOT EXISTS time_log (
+                id INTEGER PRIMARY KEY,
+                page_date TEXT NOT NULL,               -- FK to pages.date (yyyy-MM-dd)
+                project_id INTEGER NOT NULL,           -- FK to projects.id
+                activity_id INTEGER NOT NULL,          -- FK to activities.id
+                minutes INTEGER NOT NULL,              -- duration in minutes
+                note TEXT,
+                created_at TEXT NOT NULL DEFAULT (
+                    strftime('%Y-%m-%dT%H:%M:%fZ','now')
+                ),
+                FOREIGN KEY(page_date) REFERENCES pages(date) ON DELETE CASCADE,
+                FOREIGN KEY(project_id) REFERENCES projects(id) ON DELETE RESTRICT,
+                FOREIGN KEY(activity_id) REFERENCES activities(id) ON DELETE RESTRICT
+            );
+
+            CREATE INDEX IF NOT EXISTS ix_time_log_date
+                ON time_log(page_date);
+            CREATE INDEX IF NOT EXISTS ix_time_log_project
+                ON time_log(project_id);
+            CREATE INDEX IF NOT EXISTS ix_time_log_activity
+                ON time_log(activity_id);
             """
         )
         self.conn.commit()
@@ -746,6 +790,220 @@ class DBManager:
             revisions_by_date,
         )
 
+    # -------- Time logging: projects & activities ---------------------
+
+    def list_projects(self) -> list[ProjectRow]:
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            "SELECT id, name FROM projects ORDER BY LOWER(name);"
+        ).fetchall()
+        return [(r["id"], r["name"]) for r in rows]
+
+    def add_project(self, name: str) -> int:
+        name = name.strip()
+        if not name:
+            raise ValueError("empty project name")
+        with self.conn:
+            cur = self.conn.cursor()
+            cur.execute(
+                "INSERT OR IGNORE INTO projects(name) VALUES (?);",
+                (name,),
+            )
+        row = cur.execute(
+            "SELECT id, name FROM projects WHERE name = ?;",
+            (name,),
+        ).fetchone()
+        return row["id"]
+
+    def rename_project(self, project_id: int, new_name: str) -> None:
+        new_name = new_name.strip()
+        if not new_name:
+            return
+        with self.conn:
+            self.conn.execute(
+                "UPDATE projects SET name = ? WHERE id = ?;",
+                (new_name, project_id),
+            )
+
+    def delete_project(self, project_id: int) -> None:
+        with self.conn:
+            self.conn.execute(
+                "DELETE FROM projects WHERE id = ?;",
+                (project_id,),
+            )
+
+    def list_activities(self) -> list[ActivityRow]:
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            "SELECT id, name FROM activities ORDER BY LOWER(name);"
+        ).fetchall()
+        return [(r["id"], r["name"]) for r in rows]
+
+    def add_activity(self, name: str) -> int:
+        name = name.strip()
+        if not name:
+            raise ValueError("empty activity name")
+        with self.conn:
+            cur = self.conn.cursor()
+            cur.execute(
+                "INSERT OR IGNORE INTO activities(name) VALUES (?);",
+                (name,),
+            )
+        row = cur.execute(
+            "SELECT id, name FROM activities WHERE name = ?;",
+            (name,),
+        ).fetchone()
+        return row["id"]
+
+    def rename_activity(self, activity_id: int, new_name: str) -> None:
+        new_name = new_name.strip()
+        if not new_name:
+            return
+        with self.conn:
+            self.conn.execute(
+                "UPDATE activities SET name = ? WHERE id = ?;",
+                (new_name, activity_id),
+            )
+
+    def delete_activity(self, activity_id: int) -> None:
+        with self.conn:
+            self.conn.execute(
+                "DELETE FROM activities WHERE id = ?;",
+                (activity_id,),
+            )
+
+    # -------- Time logging: entries -----------------------------------
+
+    def add_time_log(
+        self,
+        date_iso: str,
+        project_id: int,
+        activity_id: int,
+        minutes: int,
+        note: str | None = None,
+    ) -> int:
+        with self.conn:
+            cur = self.conn.cursor()
+            # Ensure a page row exists even if there is no text content yet
+            cur.execute("INSERT OR IGNORE INTO pages(date) VALUES (?);", (date_iso,))
+            cur.execute(
+                """
+                INSERT INTO time_log(page_date, project_id, activity_id, minutes, note)
+                VALUES (?, ?, ?, ?, ?);
+                """,
+                (date_iso, project_id, activity_id, minutes, note),
+            )
+            return cur.lastrowid
+
+    def update_time_log(
+        self,
+        entry_id: int,
+        project_id: int,
+        activity_id: int,
+        minutes: int,
+        note: str | None = None,
+    ) -> None:
+        with self.conn:
+            self.conn.execute(
+                """
+                UPDATE time_log
+                SET project_id = ?, activity_id = ?, minutes = ?, note = ?
+                WHERE id = ?;
+                """,
+                (project_id, activity_id, minutes, note, entry_id),
+            )
+
+    def delete_time_log(self, entry_id: int) -> None:
+        with self.conn:
+            self.conn.execute(
+                "DELETE FROM time_log WHERE id = ?;",
+                (entry_id,),
+            )
+
+    def time_log_for_date(self, date_iso: str) -> list[TimeLogRow]:
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            """
+            SELECT
+                t.id,
+                t.page_date,
+                t.project_id,
+                p.name AS project_name,
+                t.activity_id,
+                a.name AS activity_name,
+                t.minutes,
+                t.note
+            FROM time_log t
+            JOIN projects  p ON p.id = t.project_id
+            JOIN activities a ON a.id = t.activity_id
+            WHERE t.page_date = ?
+            ORDER BY LOWER(p.name), LOWER(a.name), t.id;
+            """,
+            (date_iso,),
+        ).fetchall()
+
+        result: list[TimeLogRow] = []
+        for r in rows:
+            result.append(
+                (
+                    r["id"],
+                    r["page_date"],
+                    r["project_id"],
+                    r["project_name"],
+                    r["activity_id"],
+                    r["activity_name"],
+                    r["minutes"],
+                    r["note"],
+                )
+            )
+        return result
+
+    def time_report(
+        self,
+        project_id: int,
+        start_date_iso: str,
+        end_date_iso: str,
+        granularity: str = "day",  # 'day' | 'week' | 'month'
+    ) -> list[tuple[str, str, int]]:
+        """
+        Return (time_period, activity_name, total_minutes) tuples between start and end
+        for a project, grouped by period and activity.
+        time_period is:
+          - 'YYYY-MM-DD' for day
+          - 'YYYY-WW'    for week
+          - 'YYYY-MM'    for month
+        """
+        if granularity == "day":
+            bucket_expr = "page_date"
+        elif granularity == "week":
+            # ISO-like year-week; SQLite weeks start at 00
+            bucket_expr = "strftime('%Y-%W', page_date)"
+        else:  # month
+            bucket_expr = "substr(page_date, 1, 7)"  # YYYY-MM
+
+        cur = self.conn.cursor()
+        rows = cur.execute(
+            f"""
+            SELECT
+                {bucket_expr} AS bucket,
+                a.name         AS activity_name,
+                t.note         AS note,
+                SUM(t.minutes) AS total_minutes
+            FROM time_log t
+            JOIN activities a ON a.id = t.activity_id
+            WHERE t.project_id = ?
+              AND t.page_date BETWEEN ? AND ?
+            GROUP BY bucket, activity_name
+            ORDER BY bucket, LOWER(activity_name);
+            """,  # nosec
+            (project_id, start_date_iso, end_date_iso),
+        ).fetchall()
+
+        return [
+            (r["bucket"], r["activity_name"], r["note"], r["total_minutes"])
+            for r in rows
+        ]
+
     def close(self) -> None:
         if self.conn is not None:
             self.conn.close()

{bouquin-0.3.2 → bouquin-0.4}/bouquin/locales/en.json

@@ -155,8 +155,87 @@
     "bug_report_send_failed": "Could not send bug report.",
     "bug_report_sent_ok": "Bug report sent. Thank you!",
     "send": "Send",
-    "screenshot": "Take screenshot",
-    "screenshot_could_not_save": "Could not save screenshot",
-    "screenshot_get_ready": "You will have five seconds to position your screen before a preview is taken.\n\nYou will be able to click and drag to select a specific region of the preview.",
-    "screenshot_click_and_drag": "Click and drag to select a region or press enter to accept the whole region"
+    "set_reminder": "Set reminder prompt",
+    "set_reminder_prompt": "Enter a time",
+    "reminder_no_text_fallback": "You scheduled a reminder to alert you now!",
+    "invalid_time_title": "Invalid time",
+    "invalid_time_message": "Please enter a time in the format HH:MM",
+    "dismiss": "Dismiss",
+    "toolbar_alarm": "Set reminder alarm",
+   "activities": "Activities",
+   "activity": "Activity",
+   "note": "Note",
+   "activity_delete_error_message": "A problem occurred deleting the activity",
+   "activity_delete_error_title": "Problem deleting activity",
+   "activity_rename_error_message": "A problem occurred renaming the activity",
+   "activity_rename_error_title": "Problem renaming activity",
+   "activity_required_message": "An activity name is required",
+   "activity_required_title": "Activity name required",
+   "add_activity": "Add activity",
+   "add_project": "Add project",
+   "add_time_entry": "Add time entry",
+   "time_period": "Time period",
+   "by_day": "by day",
+   "by_month": "by month",
+   "by_week": "by week",
+   "date_range": "Date range",
+   "delete_activity": "Delete activity",
+   "delete_activity_confirm": "Are you sure you want to delete this activity?",
+   "delete_activity_title": "Delete activity - are you sure?",
+   "delete_project": "Delete project",
+   "delete_project_confirm": "Are you sure you want to delete this project?",
+   "delete_project_title": "Delete project - are you sure?",
+   "delete_time_entry": "Delete time entry",
+   "group_by": "Group by",
+   "hours": "Hours",
+   "invalid_activity_message": "The activity is invalid",
+   "invalid_activity_title": "Invalid activity",
+   "invalid_project_message": "The project is invalid",
+   "invalid_project_title": "Invalid project",
+   "label_key": "Label",
+   "manage_activities": "Manage activities",
+   "manage_projects": "Manage projects",
+   "manage_projects_activities": "Manage project activities",
+   "open_time_log": "Open time log",
+   "project": "Project",
+   "project_delete_error_message": "A problem occurred deleting the project",
+   "project_delete_error_title": "Problem deleting project",
+   "project_rename_error_message": "A problem occurred renaming the project",
+   "project_rename_error_title": "Problem renaming project",
+   "project_required_message": "A project is required",
+   "project_required_title": "Project required",
+   "projects": "Projects",
+   "rename_activity": "Rename activity",
+   "rename_project": "Rename project",
+   "run_report": "Run report",
+   "add_project_label": "Add a project",
+   "add_activity_label": "Add an activity",
+   "select_activity_message": "Select an activity",
+   "select_activity_title": "Select activity",
+   "select_project_message": "Select a project",
+   "select_project_title": "Select project",
+   "time_log": "Time log",
+   "time_log_collapsed_hint": "Time log",
+   "time_log_date_label": "Time log date: {date}",
+   "time_log_for": "Time log for {date}",
+   "time_log_no_date": "Time log",
+   "time_log_no_entries": "No time entries yet",
+   "time_log_report": "Time log report",
+   "time_log_report_title": "Time log for {project}",
+   "time_log_report_meta": "From {start} to {end}, grouped {granularity}",
+   "time_log_total_hours": "Total time spent",
+   "time_log_with_total": "Time log ({hours:.2f}h)",
+   "time_log_total_hours": "Total for day: {hours:.2f}h",
+   "title_key": "title",
+   "update_time_entry": "Update time entry",
+   "time_report_total": "Total: {hours:.2f} hours",
+   "no_report_title": "No report",
+   "no_report_message": "Please run a report before exporting.",
+   "total": "Total",
+   "export_csv": "Export CSV",
+   "export_csv_error_title": "Export failed",
+   "export_csv_error_message": "Could not write CSV file:\n{error}",
+   "export_pdf": "Export PDF",
+   "export_pdf_error_title": "PDF export failed",
+   "export_pdf_error_message": "Could not write PDF file:\n{error}"
 }