Merge pull request slgobinath#785 from slgobinath/master

Release v3.0.1

Author: archisman-panigrahi

.github/workflows/lint.yml

@@ -13,3 +13,10 @@ jobs:
         # this runs `ruff check`
       - run: ruff format --check
         # this runs `ruff format --check`, additionally
+  lint-appstream:
+    runs-on: ubuntu-latest
+    name: appstream
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v3
+      - run: appstreamcli validate safeeyes/platform/io.github.slgobinath.SafeEyes.metainfo.xml

.github/workflows/mypy.yml

@@ -33,6 +33,6 @@ jobs:
       - run: |
           sudo apt-get update
           sudo apt-get install -y libwayland-dev libcairo2-dev libgirepository-2.0-dev
-      - run: uv pip install -r pyproject.toml
+      - run: uv pip install -r pyproject.toml --extra wayland --extra x11
       - run: uv pip install --group types
       - run: mypy safeeyes

README.md

@@ -17,22 +17,24 @@ Visit the official site: https://slgobinath.github.io/SafeEyes/ for more details
 ## Safe Eyes command-line arguments
 
 ```text
-usage: safeeyes [-h] [-a | -d | -e | -q | -s | -t] [--debug] [--version]
-
-Safe Eyes protects your eyes from eye strain (asthenopia) by reminding you to
-take breaks while you're working long hours at the computer.
-
-optional arguments:
-  -h, --help        show this help message and exit
-  -a, --about       show the about dialog
-  -d, --disable     disable the currently running safeeyes instance
-  -e, --enable      enable the currently running safeeyes instance
-  -q, --quit        quit the running safeeyes instance and exit
-  -s, --settings    show the settings dialog
-  -t, --take-break  take a break now
-  --debug           start safeeyes in debug mode
-  --status          print the status of running safeeyes instance and exit
-  --version         show program's version number and exit
+Usage:
+  safeeyes [OPTION…]
+
+Help Options:
+  -h, --help                 Show help options
+  --help-all                 Show all help options
+  --help-gapplication        Show GApplication options
+
+Application Options:
+  -a, --about                show the about dialog
+  -s, --settings             show the settings dialog
+  -t, --take-break           take a break now
+  -d, --disable              disable the currently running safeeyes instance
+  -e, --enable               enable the currently running safeeyes instance
+  -q, --quit                 quit the running safeeyes instance and exit
+  --status                   print the status of running safeeyes instance and exit
+  --debug                    start safeeyes in debug mode
+  --version                  show program's version number and exit
 ```
 
 ## Installation guide
@@ -117,17 +119,16 @@ flatpak install flathub io.github.slgobinath.SafeEyes
 
 Ensure to meet the following dependencies:
 
-- gir1.2-notify-0.7
-- gir1.2-gtk-4.0
-- python3-babel
-- python3-croniter
-- python3-gi
-- python3-packaging
-- python3-xlib
-- python3-pywayland (optional for KDE/other wayland)
-- xprintidle (optional for X11)
-- wlrctl (optional for wayland/wlroots)
-- Python 3.10+
+- `gir1.2-notify-0.7`
+- `gir1.2-gtk-4.0`
+- `ffmpeg` or `pipewire` (any of them works)
+- `python3` (>= 3.10.0)
+- `python3-gi`
+- `python3-babel`
+- `python3-croniter`
+- `python3-packaging`
+- `python3-xlib` (required on x11)
+- **Optional**: Either `python3-pywayland` (provides smartpause in Wayland) or `xprintidle` (provides smartpause in x11).
 
 **To install Safe Eyes from PyPI:**
 
@@ -152,7 +153,7 @@ Note that on Wayland, this may still not be enough to get window icons working p
 
 ### Install in a virtual environment
 
-Some Linux systems like CentOS do not have matching dependencies available in their repository. In such systems, you can install and use Safe Eyes in a Python virtual environment.
+Some Linux systems like CentOS do not have matching dependencies available in their repository (of course you can use the flatpak there). In such systems, you can install and use Safe Eyes in a Python virtual environment.
 
 1. Install the necessary dependencies for CentOS 7
 
@@ -221,12 +222,13 @@ The available dependency groups can be found in the `pyproject.toml` file.
 0. Run `update-po.sh` to generate new translation files (which will be eventually updated by translators). Commit and push the changes to the master branch.
 1. Checkout the latest commits from the `master` branch
 2. Run `python3 -m safeeyes` to make sure nothing is broken
-3. Update the Safe Eyes version in the following places (Open the project in VSCode and search for the current version):
+3. Update the Safe Eyes version. Run `./update-version.sh "version.number.number" "New version with shiny new feature"`. 
+To manually change the version number, update the following places (Open the project in VSCode and search for the current version):
     - [pyproject.toml](https://github.com/slgobinath/SafeEyes/blob/master/pyproject.toml#L4)
     - [pyproject.toml](https://github.com/slgobinath/SafeEyes/blob/master/pyproject.toml#L35)
     - [io.github.slgobinath.SafeEyes.metainfo.xml](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/platform/io.github.slgobinath.SafeEyes.metainfo.xml#L56)
     - [about_dialog.glade](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/glade/about_dialog.glade#L74)
-4. Update the [changelog](https://github.com/slgobinath/SafeEyes/blob/master/debian/changelog) (for Ubuntu PPA release)
+4. Update the [changelog](https://github.com/slgobinath/SafeEyes/blob/master/debian/changelog) (for Ubuntu PPA release). *This is automated* if you use the `./update-version.sh` script mentioned above, but you may want to manually add more lines to describe what's new in this release.
 5. Commit the changes to `master`
 6. Create a pull-request from `master` to `release`
 7. Merge the PR to release **with merge commit** (Important to merge with merge commit)

debian/changelog

@@ -1,3 +1,9 @@
+safeeyes (3.0.1) noble; urgency=medium
+
+  * bugfix release
+
+ -- Archisman Panigrahi <[email protected]>  Thu, 11 Sep 2025 22:17:07 +0000
+
 safeeyes (3.0.0) noble; urgency=medium
 
   * Internal fixes for flatpak.

debian/control

@@ -11,15 +11,18 @@ Package: safeeyes
 Architecture: all
 Depends: ${misc:Depends}, ${python3:Depends}, 
  python3 (>= 3.10.0),
- python3-xlib,
+ python3-gi,
  python3-babel,
- x11-utils,
- xprintidle,
- alsa-utils,
  python3-croniter,
  python3-packaging,
  gir1.2-notify-0.7,
- gir1.2-gtk-4.0
+ gir1.2-gtk-4.0,
+ ffmpeg | pipewire
+Recommends:
+ python3-xlib,
+ python3-pywayland
+Suggests:
+ xprintidle
 Description: Prevent eye strain with Safe Eyes – an essential screen break reminder.
  Safe Eyes is a simple tool to remind you to take periodic breaks for your eyes. This is essential for anyone spending more time on the computer to avoid eye strain and other physical problems.
  .

pyproject.toml

@@ -1,7 +1,8 @@
 [project]
 name = "safeeyes"
-version = "3.0.0"
+version = "3.0.1"
 description = "Protect your eyes from eye strain using this continuous breaks reminder."
+license = "GPL-3.0-or-later"
 keywords = ["linux utility health eye-strain safe-eyes"]
 readme = "README.md"
 authors = [
@@ -12,7 +13,6 @@ classifiers = [
     "Environment :: X11 Applications :: GTK",
     "Environment :: Other Environment",
     "Intended Audience :: End Users/Desktop",
-    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
     "Operating System :: POSIX :: Linux",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.10",
@@ -21,23 +21,23 @@ classifiers = [
     "Topic :: Utilities",
 ]
 dependencies = [
-    "pywayland",
     "PyGObject",
     "babel",
     "packaging",
-    "python-xlib",
 ]
 requires-python = ">=3.10"
 
 [project.urls]
 Homepage = "https://github.com/slgobinath/SafeEyes"
-Downloads = "https://github.com/slgobinath/SafeEyes/archive/v3.0.0.tar.gz"
+Downloads = "https://github.com/slgobinath/SafeEyes/archive/v3.0.1.tar.gz"
 
 [project.scripts]
 safeeyes = "safeeyes.__main__:main"
 
 [project.optional-dependencies]
 healthstats = ["croniter"]
+wayland = ["pywayland"]
+x11 = ["python-xlib"]
 
 [build-system]
 requires = ["setuptools"]