Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Popularity

Small

GitHub Stars: 1.48K
Forks: 165
Contributors: 150

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package safeeyes, we found that it has been starred 1,484 times.

Security

No known security issues

Security and license risk for latest version

Release Date: Aug 6, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 1
H
2
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

GPL-3.0

Non-Permissive License

We noticed that this project uses a license which requires less permissive conditions such as disclosing the source code, stating changes or redistributing the source under the same license. It is advised to further consult the license terms before use.

Security Policy

We found a way for you to contribute to the project! Looks like safeeyes is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 87
Open PR: 14
Last Release: 5 months ago
Last Commit: 4 days ago

Further analysis of the maintenance status of safeeyes based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that safeeyes demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 150
Funding: No

A good and healthy external contribution signal for safeeyes project, which invites more than one hundred open source maintainers to collaborate on the repository.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==3.5.*, ==3.6.*, ==3.7.*, ==3.8.*, ==3.9.*

Age: 8 years
Latest Release: 5 months ago
Dependencies: 6 Direct / 10 Total
Versions: 31
Maintainers: 1
Wheels: OS Independent

Not sure how to use safeeyes?

To help you get started, we've collected the most common ways that safeeyes is being used within popular public projects.

slgobinath / SafeEyes / safeeyes / __main__.py View on Github

parser = argparse.ArgumentParser(prog='safeeyes', description=_('description'))
    group = parser.add_mutually_exclusive_group()
    group.add_argument('-a', '--about', help=_('show the about dialog'), action='store_true')
    group.add_argument('-d', '--disable', help=_('disable the currently running safeeyes instance'), action='store_true')
    group.add_argument('-e', '--enable', help=_('enable the currently running safeeyes instance'), action='store_true')
    group.add_argument('-q', '--quit', help=_('quit the running safeeyes instance and exit'), action='store_true')
    group.add_argument('-s', '--settings', help=_('show the settings dialog'), action='store_true')
    group.add_argument('-t', '--take-break', help=_('Take a break now').lower(), action='store_true')
    parser.add_argument('--debug', help=_('start safeeyes in debug mode'), action='store_true')
    parser.add_argument('--status', help=_('print the status of running safeeyes instance and exit'), action='store_true')
    parser.add_argument('--version', action='version', version='%(prog)s ' + SAFE_EYES_VERSION)
    args = parser.parse_args()

    # Initialize the logging
    Utility.intialize_logging(args.debug)
    config = Config()

    if __running():
        logging.info("Safe Eyes is already running")
        if not config.get("use_rpc_server", True):
            # RPC sever is disabled
            print(_('Safe Eyes is running without an RPC server. Turn it on to use command-line arguments.'))
            sys.exit(0)
            return
        rpc_client = RPCClient(config.get('rpc_port'))
        if args.about:
            rpc_client.show_about()
        elif args.disable:
            rpc_client.disable_safeeyes()
        elif args.enable:
            rpc_client.enable_safeeyes()

View more ways to use safeeyes

Safe Eyes

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

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 on the official repositories of many popular the distributions.

It is also 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

The Official PPA for Safe Eyes hosts the latest version of safeeyes for Ubuntu 22.04 and above.

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

On older versions of Ubuntu, an older version of Safe Eyes is available on the official repositories.

sudo apt install safeeyes

Arch

yay -S safeeyes

Gentoo

sudo emerge -av x11-misc/safeeyes

Debian

sudo apt-get install safeeyes

Fedora

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

OpenSUSE Tumbleweed

sudo zypper refresh
sudo zypper install safeeyes

Alpine Linux

sudo apk add safeeyes

Flatpak

flatpak install flathub io.github.slgobinath.SafeEyes

Other Linux & Run from source

Ensure to meet the following dependencies:

gir1.2-notify-0.7
python3-babel
python3-croniter
python3-psutil
python3-packaging
python3-xlib
xprintidle (optional)
wlrctl (wayland optional)
Python 3.10+

To install Safe Eyes:

sudo pip3 install safeeyes

After installation, restart your system to update the icons,

To run from source:

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 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.

Install the necessary dependencies for CentOS 7

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

Create a virtual environment in your home folder

mkdir ~/safeeyes
cd ~/safeeyes/

python3 -m venv venv
source venv/bin/activate
pip3 install safeeyes

Start Safe Eyes from the terminal

cd ~/safeeyes &amp; source venv/bin/activate
python3 -m safeeyes

For more details, please check the issue: #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. More details about how to write your own plugin and how to install third-party plugin are available there.

How to Release?

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.
Checkout the latest commits from the master branch
Run python3 -m safeeyes to make sure nothing is broken
Update the Safe Eyes version in the following places (Open the project in VSCode and search for the current version):
Update the changelog (for Ubuntu PPA release)
Commit the changes to master
Create a pull-request from master to release
Merge the PR to release with merge commit (Important to merge with merge commit)

License

GNU General Public License v3

safeeyes dependencies

babel croniter packaging psutil pygobject python-xlib

FAQs

What is safeeyes?

Protect your eyes from eye strain using this continuous breaks reminder. Visit Snyk Advisor to see a full health score report for safeeyes, including popularity, security, maintenance & community analysis.

Is safeeyes popular?

The python package safeeyes receives a total of 179 weekly downloads. As such, safeeyes popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is safeeyes well maintained?

We found indications that safeeyes maintenance is sustainable demonstrating some project activity. We saw a total of 150 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is safeeyes safe to use?

The python package safeeyes was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 22 December-2024, at 00:34 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Not sure how to use safeeyes?

Safe Eyes

Safe Eyes command-line arguments

Installation guide

Ubuntu, Linux Mint and other Ubuntu Derivatives

Arch

Gentoo

Debian

Fedora

OpenSUSE Tumbleweed

Alpine Linux

Flatpak

Other Linux & Run from source

Install in a virtual environment

Features

Third-party Plugins

How to Release?

License

safeeyes dependencies

FAQs

What is safeeyes?

Is safeeyes popular?

Is safeeyes well maintained?

Is safeeyes safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues