Merge pull request #710 from slgobinath/master

Release v3.0.0b1 [BETA RELEASE]

  * Update to GTK4
  * Improved Wayland support (keyboard locking, idle detection, window icons,
    fullscreen)
  * Internal refactoring (linting, formatting, typechecking on CI)
  * Improved handling of custom user stylesheets: always fall back to internal
    styles, with a lower priority
  * Translations

Author: deltragon

.editorconfig

@@ -0,0 +1,13 @@
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.{py}]
+trim_trailing_whitespace = true

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+# Use `git config blame.ignorerevsfile .git-blame-ignore-revs` to make `git blame` ignore the following commits.
+
+# format using ruff
+5bac6fe9a3b9b95abbbb364a48b5aad7c915e4ed

.github/ISSUE_TEMPLATE/bug_report.md

@@ -30,5 +30,8 @@ A clear and concise description of what you expected to happen.
 **Debug Log**
 Run the Safe Eyes using `safeeyes --debug` command attach the ~/safeeyes.log` file.
 
+**Configuration**
+Attach the configuration file, usually found in `~/.config/safeeyes/safeeyes.json`.
+
 **Screenshots**
 If applicable, add screenshots to help explain your problem.

.github/pull_request_template.md

@@ -3,3 +3,5 @@
 Describe your changes here, and link to related issues if available.
 
 Reminder to run `python validate_po.py --extract` if you have added new translatable strings.
+
+Reminder to run `ruff check`, `ruff format`, and `mypy safeeyes` to ensure coding standards are followed and types are correct.

.github/workflows/lint.yml

@@ -0,0 +1,15 @@
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint-ruff:
+    runs-on: ubuntu-latest
+    name: ruff
+    steps:
+      - name: Check out source repository
+        uses: actions/checkout@v3
+      - uses: astral-sh/ruff-action@v3
+        # this runs `ruff check`
+      - run: ruff format --check
+        # this runs `ruff format --check`, additionally

.github/workflows/mypy.yml

@@ -0,0 +1,36 @@
+# Workflow to run mypy
+# Adapted from the CPython mypy action
+name: mypy
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+env:
+  UV_SYSTEM_PYTHON: 1
+  PIP_DISABLE_PIP_VERSION_CHECK: 1
+  FORCE_COLOR: 1
+  TERM: xterm-256color  # needed for FORCE_COLOR to work on mypy on Ubuntu, see https://github.com/python/mypy/issues/13817
+
+jobs:
+  mypy:
+    name: mypy
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@22695119d769bdb6f7032ad67b9bca0ef8c4a174 # v5.4.0
+        with:
+          enable-cache: true
+          cache-dependency-glob: ''
+          cache-suffix: '3.13'
+      - name: Setup Python
+        uses: actions/setup-python@8d9ed9ac5c53483de85588cdf95a591a75ab9f55 # v5.5.0
+        with:
+          python-version: '3.13'
+      - run: sudo apt-get install -y libwayland-dev libcairo2-dev libgirepository-2.0-dev
+      - run: uv pip install -r pyproject.toml
+      - run: uv pip install --group types
+      - run: mypy safeeyes

.github/workflows/release.yml

@@ -24,15 +24,16 @@ jobs:
           pip install build wheel
 
       - name: Get Current Version
-        run: |
-          project_version=$(python3 setup.py --version)
-          echo "project_version=$project_version" >> $GITHUB_OUTPUT
+        uses: SebRollen/[email protected]
+        with:
+          file: "pyproject.toml"
+          field: project.version
         id: get_current_version
 
       - name: Create Tag
         uses: mathieudutour/[email protected]
         with:
-          custom_tag: "${{steps.get_current_version.outputs.project_version}}"
+          custom_tag: "${{steps.get_current_version.outputs.value}}"
           github_token: ${{ secrets.GH_API_SECRET }}
 
       - name: Build Changelog
@@ -44,7 +45,7 @@ jobs:
       - name: Create Release
         uses: softprops/action-gh-release@v1
         with:
-          tag_name: 'v${{steps.get_current_version.outputs.project_version}}'
+          tag_name: 'v${{steps.get_current_version.outputs.value}}'
           body: ${{steps.build_changelog.outputs.changelog}}
           token: ${{ secrets.GH_API_SECRET }}
 

MANIFEST.in

@@ -1,2 +1,6 @@
 include LICENSES/GPL-3.0-or-later.txt
 include README.md
+
+graft safeeyes
+
+global-exclude *.py[cod]

README.md

@@ -79,14 +79,13 @@ sudo apt-get install safeeyes
 ```
 
 ### Fedora
- If you want to use Smart Pause plugin, install the latest xprintidle from: [alonid/xprintidle](https://copr.fedorainfracloud.org/coprs/alonid/xprintidle/)
+Available on the [praiskup/safeeyes](https://copr.fedorainfracloud.org/coprs/praiskup/safeeyes/) COPR maintained by @praiksup
+
 ```bash
-sudo dnf install python3-psutil python3-packaging cairo-devel python3-devel gobject-introspection-devel cairo-gobject-devel
-sudo pip3 install safeeyes
-sudo gtk-update-icon-cache /usr/share/icons/hicolor
+sudo dnf -y copr enable praiskup/safeeyes
+sudo dnf -y install python3-safeeyes
 ```
-
-We are looking for an official package maintainer for Fedora. Please [contact us](https://github.com/slgobinath/SafeEyes/issues/611) if you are interested.
+For smart pause plugin, you may have to install the latest xprintidle from: [alonid/xprintidle](https://copr.fedorainfracloud.org/coprs/alonid/xprintidle/)
 
 ### OpenSUSE Tumbleweed
 
@@ -101,6 +100,13 @@ sudo zypper install safeeyes
 sudo apk add safeeyes
 ```
 
+### Chrome OS
+[Enable the Linux container](https://support.google.com/chromebook/answer/9145439?hl=en) (which is actually Debian), and install Safe Eyes with
+```
+sudo apt install safeeyes
+```
+While no tray icon is available, if you run the app, it will function in the background and will show breaks as usual. You can also change the settings by clicking on the Safe Eyes icon from the menu while the app is running, or by running the command `safeeyes -s`.
+
 ### Flatpak
 **Warning**: Many plugins and features don't work well in the flatpak. We recommend that you use one of the native packages listed above. Flatpak-only bugs should be reported at https://github.com/flathub/io.github.slgobinath.SafeEyes.
 ```bash
@@ -139,6 +145,8 @@ python3 -m safeeyes
 
 Safe Eyes installers install the required icons to `/usr/share/icons/hicolor`. When you run Safe Eyes from source without, some icons may not appear.
 
+Note that on Wayland, this may still not be enough to get window icons working properly, as Wayland requires the .desktop file to match the running application, which is hard to do when running from source. If at all possible, prefer using an installed package.
+
 
 ### Install in a virtual environment
 
@@ -170,6 +178,8 @@ Some Linux systems like CentOS do not have matching dependencies available in th
 
 For more details, please check the issue: [#329](https://github.com/slgobinath/SafeEyes/issues/329)
 
+This method has the same caveats about icons/window icons as running from source.
+
 ## Features
 
 - Remind you to take breaks with exercises to reduce RSI
@@ -194,15 +204,20 @@ Examples for translatable strings are `_("This is a string")` in Python code, or
 
 To ensure the new strings are well-formed, you can use `python validate_po.py --validate`.
 
+To ensure that the coding and formatting guidelines are followed, install [ruff](https://docs.astral.sh/ruff/) and run `ruff check` and `ruff format --check` to check for issues, as well as `ruff check --fix` and `ruff format` to autofix them.
+
+To ensure that any types are correct, install [mypy](https://github.com/python/mypy) and run `mypy safeeyes`.
+
+The last three checks are also run in CI, so a PR must pass all the tests for it to be mmerged.
+
 ## How to Release?
 
 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):
-    - [setup.py](https://github.com/slgobinath/SafeEyes/blob/master/setup.py#L82)
-    - [setup.py](https://github.com/slgobinath/SafeEyes/blob/master/setup.py#L89)
-    - [safeeyes.py](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/safeeyes.py#L42)
+    - [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)

debian/changelog

@@ -1,3 +1,19 @@
+safeeyes (3.0.0b1) noble; urgency=medium
+
+  * Update to GTK4
+
+  * Improved Wayland support (keyboard locking, idle detection, window icons,
+    fullscreen)
+
+  * Internal refactoring (linting, formatting, typechecking on CI)
+
+  * Improved handling of custom user stylesheets: always fall back to internal
+    styles, with a lower priority
+
+  * Translations
+
+ -- Mel Dafert <[email protected]>  Mon, 05 May 2025 11:30:00 +0000
+
 safeeyes (2.2.3) jammy; urgency=medium
 
   * Translations