Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/slgobinath/SafeEyes

Protect your eyes from eye strain using this simple and beautiful, yet extensible break reminder
https://github.com/slgobinath/SafeEyes

eye-strain health linux safe-eyes utility

Last synced: 15 days ago
JSON representation

Protect your eyes from eye strain using this simple and beautiful, yet extensible break reminder

Lists

README 

        
# Safe Eyes



[![Release](https://img.shields.io/github/v/release/slgobinath/SafeEyes)](https://github.com/slgobinath/SafeEyes/releases)

[![PyPI version](https://badge.fury.io/py/safeeyes.svg)](https://badge.fury.io/py/safeeyes)

[![Debian](https://badges.debian.net/badges/debian/unstable/safeeyes/version.svg)](https://packages.debian.org/unstable/safeeyes)

[![AUR](https://img.shields.io/aur/version/safeeyes)](https://aur.archlinux.org/packages/safeeyes)

[![Flathub](https://img.shields.io/flathub/v/io.github.slgobinath.SafeEyes)](https://flathub.org/apps/details/io.github.slgobinath.SafeEyes)

[![Translation status](https://hosted.weblate.org/widgets/safe-eyes/-/translations/svg-badge.svg)](https://hosted.weblate.org/engage/safe-eyes/?utm_source=widget)

[![Awesome Humane Tech](https://raw.githubusercontent.com/humanetech-community/awesome-humane-tech/main/humane-tech-badge.svg?sanitize=true)](https://github.com/humanetech-community/awesome-humane-tech)



Protect your eyes from eye strain using this simple and beautiful, yet extensible break reminder.



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

```



## Installation guide



Safe Eyes is available in Ubuntu PPA, Arch AUR, Gentoo and Python PyPI. You can choose any installation source and install on any Linux system with Python 3.



### Ubuntu, Linux Mint and other Ubuntu Derivatives



```bash

sudo add-apt-repository ppa:safeeyes-team/safeeyes

sudo apt update

sudo apt install safeeyes

```



### Arch



```bash

yay -S safeeyes

```



### Gentoo



```bash

sudo emerge -av x11-misc/safeeyes

```



### Debian



```bash

sudo apt-get install safeeyes

```



### Fedora



```bash

sudo dnf install libappindicator-gtk3 python3-psutil cairo-devel python3-devel gobject-introspection-devel cairo-gobject-devel

sudo pip3 install safeeyes

sudo gtk-update-icon-cache /usr/share/icons/hicolor

```



### OpenSUSE Tumbleweed



```bash

sudo zypper refresh

sudo zypper install safeeyes

```



### Alpine Linux



```bash

sudo apk add safeeyes

```



### Flatpak



```bash

flatpak install flathub io.github.slgobinath.SafeEyes

```



### Other Linux & Run from source



Ensure to meet the following dependencies:



- gir1.2-appindicator3-0.1 or gir1.2-ayatanaappindicator3-0.1

- gir1.2-notify-0.7

- libappindicator-gtk3

- python3-psutil

- xprintidle (optional)

- wlrctl (wayland optional)



**To install Safe Eyes:**



```bash

sudo pip3 install safeeyes

```



After installation, restart your system to update the icons,



**To run from source:**



```bash

git clone https://github.com/slgobinath/SafeEyes.git

cd SafeEyes

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.



### Install in Virtual Environment



Some Linux systems like Cent OS do not have matching dependencies available in their repository. In such systems, you can install and use Safe Eyes in a Python Virtual Environment. The following instruction was tested on Cent OS 7.



1. Install the necessary dependencies



    ```bash

    sudo yum install python3-devel dbus dbus-devel cairo cairo-devel cairomm-devel libjpeg-turbo-devel pango pango-devel pangomm pangomm-devel gobject-introspection-devel cairo-gobject-devel

    ```



2. Create a virtual environment in your home folder



    ```bash

    mkdir ~/safeeyes

    cd ~/safeeyes/



    pip3 install virtualenv --user

    virtualenv --no-site-packages venv

    source venv/bin/activate

    pip3 install dbus-python safeeyes

    ```



3. Start Safe Eyes from terminal



    ```bash

    cd ~/safeeyes & source venv/bin/activate

    python3 -m safeeyes

    ```



For more details, please check the issue: [#329](https://github.com/slgobinath/SafeEyes/issues/329)



## Features



- Remind you to take breaks with exercises to reduce RSI

- Disable keyboard during breaks

- Notification before and after breaks

- Smart pause if system is idle

- Multi-screen support

- Customizable user interface

- RPC API to control externally

- Command-line arguments to control the running instance

- Customizable using plug-ins



## Third-party Plugins



Thirdparty plugins are available at another GitHub repository: [safeeyes-plugins](https://github.com/slgobinath/safeeyes-plugins). More details about how to write your own plugin and how to install third-party plugin are available there.



## How to Release?



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#L81)

    - [setup.py](https://github.com/slgobinath/SafeEyes/blob/master/setup.py#L88)

    - [safeeyes.py](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/safeeyes.py#L43)

    - [io.github.slgobinath.SafeEyes.metainfo.xml](https://github.com/slgobinath/SafeEyes/blob/master/safeeyes/platform/io.github.slgobinath.SafeEyes.metainfo.xml#L50)

    - [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 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)



## License



GNU General Public License v3