/usr/lib/python3/dist-packages/safeeyes-2.0.0.egg-info/PKG-INFO is in safeeyes 2.0.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 | Metadata-Version: 1.1
Name: safeeyes
Version: 2.0.0
Summary: Protect your eyes from eye strain using this continuous breaks reminder.
Home-page: https://github.com/slgobinath/SafeEyes
Author: Gobinath Loganathan
Author-email: slgobinath@gmail.com
License: UNKNOWN
Download-URL: https://github.com/slgobinath/SafeEyes/archive/v2.0.0.tar.gz
Description-Content-Type: UNKNOWN
Description:
# Safe Eyes
[](https://badge.fury.io/gh/slgobinath%2FSafeEyes)
[](https://badge.fury.io/py/safeeyes)
[](https://hosted.weblate.org/engage/safe-eyes/?utm_source=widget)
Protect your eyes from eye strain using this simple and beautiful, yet extensible break reminder. A Free and Open Source Linux alternative to EyeLeo.
Visit to the official site: http://slgobinath.github.io/SafeEyes/ for more details.
## Safe Eyes command-line arguements
```
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
--version show program's version number and exit
```
## Installation guide
Safe Eyes is available in Ubuntu PPA, Arch AUR and Python PyPI. You can choose any installation source and install on any Linux system with Python 3. To see how to install Safe Eyes, visit [Getting Started](http://slgobinath.github.io/SafeEyes/#introduction)
### Compile from source
Ensure to meet the following dependencies when compiling from source:
- gir1.2-appindicator3-0.1
- gir1.2-notify-0.7
- libappindicator-gtk3
- python3-psutil
- xprintidle (optional)
## Features
- Remind you to take breaks
- Disable keyboard during breaks
- Notification before and after breaks
- Smart pause if system is idle
- Customizable using plug-ins
- Multi-screen support
- Customizable user interface
- RPC API to control externally
- Command-line arguments to control the running instance
## Writing Safe Eyes plug-in
A plugin is a combination of two files: `plugin.py` and `config.json`. These two files must be placed in a directory: `~/.config/safeeyes/plugins/<plugin-id>`. Optionally a plugin also can have an image file `icon.png` which is used to represent the plugin in the Settings dialog.
For example, a Weather plugin may have the following file structure:
```
~
└── .config
└── safeeyes
└── plugins
└── weather
├── config.json
├── icon.png
└── plugin.py
```
The `icon.png` must be `24x24` pixels size. If `icon.png` is not available, the default gear icon <img src="https://github.com/slgobinath/SafeEyes/raw/master/safeeyes/resource/ic_plugin.png" width="16" height="16"/> will be shown in the Settings dialog.
A sample `config.json` is provided below:
```json
{
"meta": {
"name": "Weather",
"description": "Show the current weather on break screen",
"version": "0.0.1"
},
"dependencies": {
"python_modules": ["pyowm"],
"shell_commands": [],
"operating_systems": [],
"desktop_environments": [],
"resources": []
},
"settings": [
{
"id": "api",
"label": "OpenWeatherMap API Key",
"type": "TEXT",
"default": ""
},
{
"id": "location",
"label": "Location",
"type": "TEXT",
"default": ""
}
],
"break_override_allowed": true
}
```
The `meta` properties must provide the name of the plugin, a short description and the current version of the plugin.
The `dependencies` property defines various dependency constraints of the plugin. The dependencies can be Python modules, commandline tools, desktop environments or Safe Eyes resources. The `operating_systems` property is reserved for operating system dependency but not checked for at the moment.
If a dependency is not available, the Safe Eyes will not load the plugin. The Settings dialog will show a warning symbol <img src="https://github.com/slgobinath/SafeEyes/raw/master/safeeyes/resource/ic_warning.png" width="16" height="16"> and a message to install/check the missing dependencies. Dependencies are checked in the order of *Desktop Environment*, *Python Modules*, *Commandline Tools* and *Resources*. If a dependency is not available, Safe Eyes will stop looking for the rest.
The configurations related to the plugin must be defined in `settings`. Each setting must have an `id`, `label`, `type` and a default value matching the `type`. Safe Eyes 2.0.0 supports only the following types: `INT`, `TEXT` and `BOOL`. According to the types, Settings dialog will show a *Spin*, *Text Field* or *Switch Button* as the input field.
The optional `break_override_allowed` property lets users to override the status of plugins by enable or disable based on break.
The `plugin.py` can have one or more of the following functions:
```python
def on_init(context, safeeyes_config, plugin_config):
"""
Executes after loading the plugin for the first time and after every changes in configuration.
"""
pass
def on_start():
"""
Executes when Safe Eyes is enabled.
"""
pass
def on_stop():
"""
Executes when Safe Eyes is disabled.
"""
pass
def enable():
"""
Executes after plugin.py is loaded as a module.
"""
pass
def disable():
"""
Executes after disabling the plugin at the runtime.
"""
pass
def update_next_break(date_time):
"""
Update the next break time.
"""
pass
def on_pre_break(break_obj):
"""
Executes before on_start_break break.
"""
pass
def on_start_break(break_obj):
"""
Executes when starting a break.
"""
pass
def on_countdown(countdown, seconds):
"""
Keep track of seconds passed from the beginning of break.
"""
pass
def on_stop_break():
"""
Executes at the end of breaks.
"""
pass
def on_exit():
"""
Executes before Safe Eyes exits
"""
pass
def get_widget_title(break_obj):
"""
Return the widget title.
"""
return 'Widget Title'
def get_widget_content(break_obj):
"""
Return the widget content.
"""
return 'Widget Content'
```
All the above functions are optional and it is the developer's choice to choose the functions to implement. The `pre_break` and `start_break` methods can return `True` if they want to skip the specific break. If a plugin skips the break by returning `True`, the corresponding lifecycle method will not be invoked from the upcoming plugins. The execution order of plugins is not predefined so the plugins should not make any assumption about other plugins.
Plugins willing to show an entry in the break screen must implement both `get_widget_title` and `get_widget_content`. They should return a single line string as the output. If either the title or content is an empty string, the message will not be displayed in the break screen. It is added as an option to skip selective breaks depending on the domain.
A sample `plugin.py` is shown below to disaplay the current weather information:
```python
import logging
import pyowm
api = None
location = None
owm = None
weather_details = None
def init(ctx, safeeyes_config, plugin_config):
"""
Initialize the plugin.
"""
logging.debug('Initialize Weather plugin')
global api
global location
global owm
api = plugin_config['api']
location = plugin_config['location']
if api != "" and location != "":
owm = pyowm.OWM(api)
def get_widget_title(break_obj):
"""
Return the widget title.
"""
logging.debug('Get the weather information')
global weather_details
if owm:
try:
observation = owm.weather_at_place(location)
weather = observation.get_weather()
temp = weather.get_temperature('celsius').get('temp')
humidity = weather.get_humidity()
wind_speed = weather.get_wind().get('speed')
weather_details = 'Temperature: %s℃\t\tHumidity: %s\tWind Speed: %s' % (temp, humidity, wind_speed)
except BaseException:
# Can be a network error
weather_details = None
if weather_details:
return 'Weather'
def get_widget_content(break_obj):
"""
Return the weather details.
"""
return weather_details
```
To get more ideas, go through the existing plugins available in [system plugins](https://github.com/slgobinath/SafeEyes/tree/master/safeeyes/plugins).
## License
GNU General Public License v3
Keywords: linux utility health eye-strain safe-eyes
Platform: UNKNOWN
Classifier: Operating System :: POSIX :: Linux
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: X11 Applications :: GTK
Classifier: Intended Audience :: End Users/Desktop
Classifier: Topic :: Utilities
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
|