├── .gitignore ├── requirements.txt ├── screenshot.png ├── screenshot_nagbar.png ├── __pycache__ └── pomodoro_client.cpython-311.pyc ├── renovate.json ├── i3_gnome_pomodoro ├── __pycache__ │ └── pomodoro_client.cpython-311.pyc └── pomodoro_client.py ├── pyproject.toml ├── README.md ├── poetry.lock └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *#* 3 | .mypy_cache 4 | *flycheck* 5 | dist 6 | -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | pygobject==3.32.1 2 | pydbus==0.6.0 3 | click==6.7 4 | i3ipc==1.3.0 5 | -------------------------------------------------------------------------------- /screenshot.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kantord/i3-gnome-pomodoro/HEAD/screenshot.png -------------------------------------------------------------------------------- /screenshot_nagbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kantord/i3-gnome-pomodoro/HEAD/screenshot_nagbar.png -------------------------------------------------------------------------------- /__pycache__/pomodoro_client.cpython-311.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kantord/i3-gnome-pomodoro/HEAD/__pycache__/pomodoro_client.cpython-311.pyc -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://docs.renovatebot.com/renovate-schema.json", 3 | "extends": [ 4 | "config:recommended" 5 | ] 6 | } 7 | -------------------------------------------------------------------------------- /i3_gnome_pomodoro/__pycache__/pomodoro_client.cpython-311.pyc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/kantord/i3-gnome-pomodoro/HEAD/i3_gnome_pomodoro/__pycache__/pomodoro_client.cpython-311.pyc -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [tool.poetry] 2 | name = "i3-gnome-pomodoro" 3 | version = "0.1.0" 4 | description = "" 5 | authors = ["Daniel Kantor "] 6 | readme = "README.md" 7 | 8 | [tool.poetry.dependencies] 9 | python = "^3.11" 10 | pygobject = "^3.46.0" 11 | pydbus = "^0.6.0" 12 | click = "^8.1.7" 13 | i3ipc = "^2.2.1" 14 | blinkstick = "^1.2.0" 15 | pyusb = "^1.2.1" 16 | 17 | 18 | [tool.poetry.scripts] 19 | i3-gnome-pomodoro = "i3_gnome_pomodoro.pomodoro_client:main" 20 | 21 | 22 | 23 | [build-system] 24 | requires = ["poetry-core"] 25 | build-backend = "poetry.core.masonry.api" 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # i3-gnome-pomodoro 2 | Integrate gnome-pomodoro into i3. Support i3bar, polybar and waybar. 3 | 4 | Here's what i3-gnome-pomodoro looks like on my i3bar: 5 | ![Pomodoro 24:45 |  075%  uvsFvTK7SffCNaP9 | |  100% |  100% |  55°C |  24.6 GB |  01. 07  23.19 |  70%](screenshot.png?raw=true) 6 | 7 | i3-gnome-pomodoro can integrate with [status-one-liner](https://github.com/kantord/status-one-liner). 8 | 9 | You can optionally disable certain workspaces during a pomodoro. They are still accessible when you pause a pomodoro. 10 | ![Workspace 10: mail is disabled during a pomodoro.](screenshot_nagbar.png) 11 | 12 | ## About 13 | i3-gnome-pomodoro uses dbus to integrate gnome-pomodoro into i3. Currently it supports the following features: 14 | - View timer status in a terminal, and therefore 15 | - Show timer status on i3bar 16 | - Control pomodoro state in a terminal, and therefore 17 | - Control pomodoro state using bindsym (keyboard and mouse shortcuts) 18 | - *Optionally* suppressing dunst desktop notifications while a pomodoro is active and showing them when the break starts 19 | - *Optionally* disabling specific workspaces (such as instant messaging) while you are on a pomodoro. You can still access those workspaces, if you pause the pomodoro. 20 | - *Optionally* displaying a nagbar warning if you try to access a workspace that you have disabled during your pomodoro. 21 | 22 | ## Usage and setup 23 | 24 | ### Install 25 | 26 | To install 3i-gnome-pomodoro, you can use pipx: 27 | 28 | ```bash 29 | pipx install i3-gnome-pomodoro 30 | ``` 31 | 32 | This is the recommended way. 33 | 34 | #### AUR 35 | **Note:** The recommended way to install i3-gnome-pomodoro is through pipx. The AUR package is not maintained 36 | by me. 37 | 38 | `i3-gnome-pomodoro` is available on [AUR](https://aur.archlinux.org/packages/i3-gnome-pomodoro-git), you can install it with your favorite package manager: 39 | ``` sh 40 | $ yay -S i3-gnome-pomodoro-git 41 | ``` 42 | 43 | #### Local development 44 | 45 | Use `poetry` to install local development dependencies: 46 | 47 | ```bash 48 | poetry install 49 | ``` 50 | 51 | This is not required for normal usage, only if you want to make changes to i3-gnome-pomodoro. 52 | 53 | ### Terminal 54 | Timer status can be viewed by simply running `./pomodoro-client.py`. Example output: 55 | 56 | $ ./pomodoro-client.py status 57 | Pomodoro 15:35 58 | 59 | The timer state can be manipulated using the commands `pause`, `resume`, `start`, 60 | `stop`, `skip`, `toggle` and `reset`. For example: 61 | 62 | $ ./pomodoro-client.py pause 63 | 64 | 65 | ### i3bar 66 | Unfortunately, i3status cannot be used to display a custom feature on i3bar. However, another application can use i3status to collect information and combine it with custom features. A very simple way to do that is to create a script in this fashion: 67 | ``` 68 | #!/usr/bin/env bash 69 | 70 | i3status -c ~/.i3/i3status.conf | while : 71 | do 72 | read line 73 | pomodoro=`~/repos/i3-gnome-pomodoro/pomodoro-client.py status` 74 | echo "$pomodoro| $line" || exit 1 75 | done 76 | ``` 77 | 78 | After saving that script, make sure you update your i3 config to set it as your `status_command`: 79 | ``` 80 | bar { 81 | status_command ~/repos/arch-config/i3status.sh 82 | } 83 | ``` 84 | 85 | And then restart i3 so the changes be in effect right away: 86 | 87 | $ i3-msg restart 88 | 89 | If you want to use an i3status replacement, please follow its respective documentation to get information about how you can use i3-gnome-pomodoro. 90 | 91 | ### polybar 92 | 93 | I use the following module in polybar: 94 | 95 | ``` 96 | [module/pomodoro] 97 | type = custom/script 98 | exec = i3-gnome-pomodoro status 99 | interval = 1 100 | ``` 101 | 102 | with the `i3-gnome-pomodoro status --always` flag thing like the block below, becomes possible 103 | 104 | ``` 105 | [module/pomodoro] 106 | type = custom/script 107 | click-left = i3-gnome-pomodoro toggle 108 | click-middle = gnome-pomodoro 109 | click-right = i3-gnome-pomodoro start_stop 110 | exec = i3-gnome-pomodoro status --always 111 | interval = 1 112 | 113 | ``` 114 | 115 | ### waybar 116 | 117 | I use the following module in waybar 118 | 119 | config 120 | 121 | ``` 122 | "custom/pomodoro": { 123 | "exec": "i3-gnome-pomodoro status --format=waybar --show-seconds", 124 | "return-type": "json", 125 | "interval": 1, 126 | "format": "Pomodoro {}", 127 | "on-click": "i3-gnome-pomodoro start", 128 | "on-click-middle": "i3-gnome-pomodoro toggle", 129 | "on-click-right": "i3-gnome-pomodoro stop", 130 | }, 131 | 132 | ``` 133 | 134 | style.css 135 | 136 | ```css 137 | #custom-pomodoro.paused { 138 | border-bottom: 3px solid @yellow; 139 | } 140 | ``` 141 | 142 | ### Refresh rate 143 | i3-gnome-pomodoro displays a countdown timer on i3bar. If you use i3status, setting `resfresh_rate` in your i3status configuration can probably result in a better user experience. I personally use this configuration: 144 | 145 | ``` 146 | general { 147 | interval = 1 148 | } 149 | ``` 150 | 151 | ### Blinkstick 152 | 153 | You can reflect your Pomodoro status on a Blinkstick by using the `--blinkstick` flag 154 | in the status command. 155 | 156 | ### Keyboard shortcuts 157 | I use the following key bindings in my i3 config: 158 | ``` 159 | bindsym $mod+F9 exec "~/repos/i3-gnome-pomodoro/pomodoro-client.py start" 160 | bindsym $mod+F10 exec "~/repos/i3-gnome-pomodoro/pomodoro-client.py toggle" 161 | bindsym $mod+F11 exec "~/repos/i3-gnome-pomodoro/pomodoro-client.py skip" 162 | bindsym $mod+F12 exec "~/repos/i3-gnome-pomodoro/pomodoro-client.py stop" 163 | ``` 164 | 165 | 166 | ### Suppressing dunst notifications and disabling workspaces 167 | i3-gnome-pomodoro has a daemon that can suppress dunst notifications while a 168 | pomodoro is active. After your pomodoro is over, dunst still delivers delayed 169 | notifications. To use this daemon, launch it manually when needed or add this 170 | to your i3 configuration to launch it on startup: 171 | 172 | ``` 173 | exec ~/repos/i3-gnome-pomodoro/pomodoro-client.py daemon & 174 | ``` 175 | 176 | If you want to disable any workspaces during your pomodoro, you can do so by 177 | specifying there workspace number. For example, I generally use workspace 10 178 | for IM, Social Media and Workspace 9 for email. Therefore I want them disabled 179 | while I'm on a pomodoro. So, I execute my daemon like this: 180 | 181 | ``` 182 | exec ~/repos/i3-gnome-/pomodoro-client.py daemon 9 10 & 183 | ``` 184 | 185 | This works even if you label your workspaces. For example, I use the name "9: mail" 186 | for my email workspace but I still reference it with "9". 187 | 188 | I also like to have a nagbar warning shown when I still try to access a distracting workspace: 189 | 190 | ``` 191 | exec ~/repos/i3-gnome-/pomodoro-client.py daemon 9 10 --nagbar & 192 | ``` 193 | -------------------------------------------------------------------------------- /poetry.lock: -------------------------------------------------------------------------------- 1 | # This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand. 2 | 3 | [[package]] 4 | name = "blinkstick" 5 | version = "1.2.0" 6 | description = "Python package to control BlinkStick USB devices." 7 | optional = false 8 | python-versions = "*" 9 | files = [ 10 | {file = "BlinkStick-1.2.0-py3-none-any.whl", hash = "sha256:eeabbb207180b46f92aec392dd508c24e6ddaede6101f4eb54e7a91bed424d08"}, 11 | {file = "BlinkStick-1.2.0.tar.gz", hash = "sha256:a9324e04a3733c89476182bddeb109b4487de0dc7d01f587e07e191d501cb365"}, 12 | ] 13 | 14 | [package.dependencies] 15 | pywinusb = "*" 16 | 17 | [[package]] 18 | name = "click" 19 | version = "8.1.7" 20 | description = "Composable command line interface toolkit" 21 | optional = false 22 | python-versions = ">=3.7" 23 | files = [ 24 | {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"}, 25 | {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"}, 26 | ] 27 | 28 | [package.dependencies] 29 | colorama = {version = "*", markers = "platform_system == \"Windows\""} 30 | 31 | [[package]] 32 | name = "colorama" 33 | version = "0.4.6" 34 | description = "Cross-platform colored terminal text." 35 | optional = false 36 | python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7" 37 | files = [ 38 | {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"}, 39 | {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"}, 40 | ] 41 | 42 | [[package]] 43 | name = "i3ipc" 44 | version = "2.2.1" 45 | description = "An improved Python library to control i3wm and sway" 46 | optional = false 47 | python-versions = ">=3.4.0" 48 | files = [ 49 | {file = "i3ipc-2.2.1-py3-none-any.whl", hash = "sha256:c0b898223d50d42c90c818deb5033d1304c582755547dee7d15df3e3781bc690"}, 50 | {file = "i3ipc-2.2.1.tar.gz", hash = "sha256:e880d7d7147959ead5cb34764f08b97b41385b36eb8256e8af1ce163dbcccce8"}, 51 | ] 52 | 53 | [package.dependencies] 54 | python-xlib = "*" 55 | 56 | [[package]] 57 | name = "pycairo" 58 | version = "1.25.1" 59 | description = "Python interface for cairo" 60 | optional = false 61 | python-versions = ">=3.8" 62 | files = [ 63 | {file = "pycairo-1.25.1-cp310-cp310-win32.whl", hash = "sha256:cacb5c2abbfdfc79c728ab261ff791511e4957b606c660f9b380975b678b728f"}, 64 | {file = "pycairo-1.25.1-cp310-cp310-win_amd64.whl", hash = "sha256:109ebbeb5bbc510b726fc31251071264dec241e5084d0668f846d7e17e5af8e0"}, 65 | {file = "pycairo-1.25.1-cp310-cp310-win_arm64.whl", hash = "sha256:b19269a8bf9ab5e3c617f2699bed00977fd02ff304339a233654456c0236f7c6"}, 66 | {file = "pycairo-1.25.1-cp311-cp311-win32.whl", hash = "sha256:b10e58a3ce41e487aae15050b630742e880d4135cee7a69cee2c0ea2a0b4bd0a"}, 67 | {file = "pycairo-1.25.1-cp311-cp311-win_amd64.whl", hash = "sha256:fcf5511b05a652a0ef87f626bf26bfc1b796a67f0d1bd40781c62986fb41c356"}, 68 | {file = "pycairo-1.25.1-cp311-cp311-win_arm64.whl", hash = "sha256:4133ba3ef6d875aa1b16643dc0801846f463b8e78750f5308c41902dfeac5b9a"}, 69 | {file = "pycairo-1.25.1-cp312-cp312-win32.whl", hash = "sha256:56fee2837a07ecd914f4fbf78ff59445f78becd658fe36125101925dd489eb94"}, 70 | {file = "pycairo-1.25.1-cp312-cp312-win_amd64.whl", hash = "sha256:fb31eec2c41ec74e23dc0fc9feb4007b4c37f78ec76220ed92530b342e09821a"}, 71 | {file = "pycairo-1.25.1-cp312-cp312-win_arm64.whl", hash = "sha256:27011d822952d7817130fc17f490de94328590bc8d45bdbca9ec4a47039fca22"}, 72 | {file = "pycairo-1.25.1-cp38-cp38-win32.whl", hash = "sha256:9a7c5ed92fe87f60e9796777d5255f2df2deeb8ab1e3c296e67a1d8c9790808c"}, 73 | {file = "pycairo-1.25.1-cp38-cp38-win_amd64.whl", hash = "sha256:48603ad31616140ad6fa097f13086d0ce8f29ead35ad6a215962f3b0496a5a70"}, 74 | {file = "pycairo-1.25.1-cp39-cp39-win32.whl", hash = "sha256:97666c084e9eb1c08c7fd6d306d153767acdf03c0d80349ec55863cecd4138e0"}, 75 | {file = "pycairo-1.25.1-cp39-cp39-win_amd64.whl", hash = "sha256:ac5437d140eccd97af12a618cc1ace0d9a85f1269f29e963751949f132828b21"}, 76 | {file = "pycairo-1.25.1-cp39-cp39-win_arm64.whl", hash = "sha256:bda5d10adbf1f5eba6b524b5a70ccf7f659680b77e691ff94b312f25a6fcc91f"}, 77 | {file = "pycairo-1.25.1.tar.gz", hash = "sha256:7e2be4fbc3b4536f16db7a11982cbf713e75069a4d73d44fe5a49b68423f5c0c"}, 78 | ] 79 | 80 | [[package]] 81 | name = "pydbus" 82 | version = "0.6.0" 83 | description = "Pythonic DBus library" 84 | optional = false 85 | python-versions = "*" 86 | files = [ 87 | {file = "pydbus-0.6.0-py2.py3-none-any.whl", hash = "sha256:66b80106352a718d80d6c681dc2a82588048e30b75aab933e4020eb0660bf85e"}, 88 | {file = "pydbus-0.6.0.tar.gz", hash = "sha256:4207162eff54223822c185da06c1ba8a34137a9602f3da5a528eedf3f78d0f2c"}, 89 | ] 90 | 91 | [[package]] 92 | name = "pygobject" 93 | version = "3.46.0" 94 | description = "Python bindings for GObject Introspection" 95 | optional = false 96 | python-versions = ">=3.8, <4" 97 | files = [ 98 | {file = "PyGObject-3.46.0.tar.gz", hash = "sha256:481437b05af0a66b7c366ea052710eb3aacbb979d22d30b797f7ec29347ab1e6"}, 99 | ] 100 | 101 | [package.dependencies] 102 | pycairo = ">=1.16,<2.0" 103 | 104 | [[package]] 105 | name = "python-xlib" 106 | version = "0.33" 107 | description = "Python X Library" 108 | optional = false 109 | python-versions = "*" 110 | files = [ 111 | {file = "python-xlib-0.33.tar.gz", hash = "sha256:55af7906a2c75ce6cb280a584776080602444f75815a7aff4d287bb2d7018b32"}, 112 | {file = "python_xlib-0.33-py2.py3-none-any.whl", hash = "sha256:c3534038d42e0df2f1392a1b30a15a4ff5fdc2b86cfa94f072bf11b10a164398"}, 113 | ] 114 | 115 | [package.dependencies] 116 | six = ">=1.10.0" 117 | 118 | [[package]] 119 | name = "pyusb" 120 | version = "1.2.1" 121 | description = "Python USB access module" 122 | optional = false 123 | python-versions = ">=3.6.0" 124 | files = [ 125 | {file = "pyusb-1.2.1-py3-none-any.whl", hash = "sha256:2b4c7cb86dbadf044dfb9d3a4ff69fd217013dbe78a792177a3feb172449ea36"}, 126 | {file = "pyusb-1.2.1.tar.gz", hash = "sha256:a4cc7404a203144754164b8b40994e2849fde1cfff06b08492f12fff9d9de7b9"}, 127 | ] 128 | 129 | [[package]] 130 | name = "pywinusb" 131 | version = "0.4.2" 132 | description = "A package that simplifies USB/HID communications on windows" 133 | optional = false 134 | python-versions = "*" 135 | files = [ 136 | {file = "pywinusb-0.4.2.zip", hash = "sha256:e2f5e89f7b74239ca4843721a9bda0fc99014750630c189a176ec0e1b35e86df"}, 137 | ] 138 | 139 | [[package]] 140 | name = "six" 141 | version = "1.16.0" 142 | description = "Python 2 and 3 compatibility utilities" 143 | optional = false 144 | python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" 145 | files = [ 146 | {file = "six-1.16.0-py2.py3-none-any.whl", hash = "sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254"}, 147 | {file = "six-1.16.0.tar.gz", hash = "sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926"}, 148 | ] 149 | 150 | [metadata] 151 | lock-version = "2.0" 152 | python-versions = "^3.11" 153 | content-hash = "cf57dbbafc883bad7fa811a9d5d0aaadedb5f743ed55a8e46a3fa2c1b38c0ab8" 154 | -------------------------------------------------------------------------------- /i3_gnome_pomodoro/pomodoro_client.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | from gi.repository import GLib 4 | from pydbus import SessionBus 5 | import subprocess 6 | from threading import Thread 7 | import click 8 | import i3ipc 9 | import math 10 | import os 11 | 12 | 13 | bus = SessionBus() 14 | 15 | 16 | def get_notification_proxy(): 17 | return bus.get("org.freedesktop.Notifications", "/org/freedesktop/Notifications") 18 | 19 | 20 | def get_pomodoro_proxy(): 21 | return bus.get("org.gnome.Pomodoro", "/org/gnome/Pomodoro") 22 | 23 | 24 | def format_time(seconds, show_seconds): 25 | time = "{minutes:02d}".format(minutes=int(math.floor(round(seconds) / 60))) + ( 26 | ":{seconds:02d}".format(seconds=int(round(seconds) % 60)) 27 | if show_seconds 28 | else "m" 29 | ) 30 | 31 | return time 32 | 33 | 34 | def format_is_paused(is_paused, format): 35 | if format == "waybar": 36 | return "paused" if is_paused else "" 37 | return " PAUSED " if is_paused else "" 38 | 39 | 40 | def format_state(state, icon_text): 41 | return { 42 | "pomodoro": icon_text, 43 | "short-break": "Break", 44 | "long-break": "Long Break", 45 | }[state] 46 | 47 | 48 | def extract_pomodoro_data(pomodoro): 49 | return { 50 | "elapsed": pomodoro.Elapsed, 51 | "is_paused": pomodoro.IsPaused, 52 | "duration": pomodoro.StateDuration, 53 | "remaining": pomodoro.StateDuration - pomodoro.Elapsed, 54 | "state": pomodoro.State, 55 | } 56 | 57 | 58 | def format_pomodoro_data(pomodoro_data, icon_text, show_seconds, format): 59 | return { 60 | "elapsed": format_time(pomodoro_data["elapsed"], show_seconds), 61 | "duration": format_time(pomodoro_data["duration"], show_seconds), 62 | "remaining": format_time(pomodoro_data["remaining"], show_seconds), 63 | "is_paused": format_is_paused(pomodoro_data["is_paused"], format), 64 | "state": format_state(pomodoro_data["state"], icon_text), 65 | } 66 | 67 | 68 | def format_output_text(pomodoro_data, always, icon_text, show_seconds, format): 69 | if pomodoro_data["state"] != "null": 70 | return "{state} {remaining} {is_paused}".format( 71 | **format_pomodoro_data(pomodoro_data, icon_text, show_seconds, format) 72 | ) 73 | if always: 74 | return icon_text 75 | return "" 76 | 77 | 78 | def format_output_waybar(pomodoro_data, always, icon_text, show_seconds, format): 79 | import json 80 | 81 | output = {"class": "stopped", "text": "", "tooltip": ""} 82 | if pomodoro_data["state"] != "null": 83 | if icon_text != "": 84 | icon_text = icon_text + " " 85 | data = format_pomodoro_data(pomodoro_data, icon_text, show_seconds, format) 86 | output["class"] = data["is_paused"] 87 | output["text"] = "{}{}".format(icon_text, data["remaining"]) 88 | output["tooltip"] = "Elapsed: {}\nRemaining: {}".format( 89 | data["elapsed"], data["remaining"] 90 | ) 91 | return json.dumps(output) 92 | if always: 93 | output["text"] = icon_text 94 | return json.dumps(output) 95 | 96 | 97 | def format_output(pomodoro_data, always, icon_text, show_seconds, format="text"): 98 | if pomodoro_data["state"] != "null": 99 | return "{state} {remaining} {is_paused}".format( 100 | **format_pomodoro_data(pomodoro_data, icon_text, show_seconds, format) 101 | ) 102 | if always: 103 | return icon_text 104 | return "" 105 | 106 | 107 | def detect_nagbar(): 108 | with open(os.devnull, "w") as devnull: 109 | if subprocess.call(["pgrep", "i3"], stdout=devnull) == 0: 110 | return "i3-nagbar" 111 | else: 112 | return "swaynag" 113 | 114 | 115 | def set_blinkstick_color(color_hex): 116 | from blinkstick import blinkstick 117 | 118 | for device in blinkstick.find_all(): 119 | device.set_color(hex=color_hex) 120 | 121 | 122 | def format_blinkstick(pomodoro_data): 123 | color = { 124 | "pomodoro": "#ff0000", 125 | "short-break": "#00ff00", 126 | "long-break": "#0000ff", 127 | "null": "#000000", 128 | }[pomodoro_data["state"]] 129 | set_blinkstick_color(color) 130 | 131 | 132 | @click.group() 133 | def main(): 134 | pass 135 | 136 | 137 | @click.option( 138 | "--blinkstick/--no-blinkstick", 139 | default=False, 140 | help="""Display status using a blinkstick LED""", 141 | ) 142 | @click.option("--always/--not-always", default=False, help="""Show a constant icon.""") 143 | @click.option( 144 | "--show-seconds/--no-seconds", default=True, help="""Show seconds in timers""" 145 | ) 146 | @click.option("--icon-text", default="Pomodoro", help="What to show as icon.") 147 | @click.option( 148 | "--format", 149 | default="text", 150 | help="""Output format, 'text' or 'waybar', default 'text'""", 151 | ) 152 | @click.command( 153 | help=""" 154 | Returns a string descriping the current pomodoro state. 155 | """ 156 | ) 157 | def status(always, icon_text, show_seconds, format, blinkstick): 158 | pomodoro = get_pomodoro_proxy() 159 | pomodoro_data = extract_pomodoro_data(pomodoro) 160 | if blinkstick: 161 | format_blinkstick(pomodoro_data) 162 | 163 | if format == "waybar": 164 | click.echo( 165 | format_output_waybar(pomodoro_data, always, icon_text, show_seconds, format) 166 | ) 167 | else: 168 | click.echo( 169 | format_output_text(pomodoro_data, always, icon_text, show_seconds, format) 170 | ) 171 | 172 | 173 | @click.command(help="""Pauses the current pomodoro if any is running.""") 174 | def pause(): 175 | get_pomodoro_proxy().Pause() 176 | 177 | 178 | @click.command(help="""Resume pomodoro if paused.""") 179 | def resume(): 180 | get_pomodoro_proxy().Resume() 181 | 182 | 183 | @click.command(help="Start a pomodoro.") 184 | def start(): 185 | get_pomodoro_proxy().Start() 186 | 187 | 188 | @click.command(help="Stop current pomodoro.") 189 | def stop(): 190 | get_pomodoro_proxy().Stop() 191 | 192 | 193 | @click.command( 194 | help="Toggling function to start a pomodoro if none is running or stop the current one." 195 | ) 196 | def start_stop(): 197 | pomodoro = get_pomodoro_proxy() 198 | if pomodoro.State == "null": 199 | pomodoro.Start() 200 | elif pomodoro.State == "pomodoro": 201 | pomodoro.Stop() 202 | 203 | 204 | @click.command(help="Skip the current activity.") 205 | def skip(): 206 | get_pomodoro_proxy().Skip() 207 | 208 | 209 | @click.command() 210 | def reset(help="Reset the current pomodoro."): 211 | get_pomodoro_proxy().Reset() 212 | 213 | 214 | @click.command() 215 | def toggle(help="Toggling function to pause/resume current pomodoro."): 216 | pomodoro = get_pomodoro_proxy() 217 | if pomodoro.IsPaused: 218 | pomodoro.Resume() 219 | else: 220 | pomodoro.Pause() 221 | 222 | 223 | def dunst_action(action): 224 | notify = get_notification_proxy() 225 | notify.Notify("", 0, "", action, "", "", "", 0) 226 | 227 | 228 | def stop_dunst(): 229 | dunst_action("DUNST_COMMAND_PAUSE") 230 | 231 | 232 | def start_dunst(): 233 | dunst_action("DUNST_COMMAND_RESUME") 234 | 235 | 236 | def handle_state(state, old_state): 237 | if state["name"] == "pomodoro": 238 | stop_dunst() 239 | else: 240 | start_dunst() 241 | 242 | 243 | def show_message(message, is_error=False): 244 | type_ = "error" if is_error else "warning" 245 | subprocess.Popen('%s -t %s -m "%s"' % (detect_nagbar(), type_, message), shell=True) 246 | 247 | 248 | def get_focused_workspace(i3): 249 | return i3.get_tree().find_focused().workspace() 250 | 251 | 252 | def create_workspace_policy(disabled_during_pomodoro): 253 | def allowed_workspace(number): 254 | pomodoro = get_pomodoro_proxy() 255 | if pomodoro.State == "pomodoro" and pomodoro.IsPaused == False: 256 | return number not in disabled_during_pomodoro 257 | else: 258 | return True 259 | 260 | return allowed_workspace 261 | 262 | 263 | def activate_workspace(i3, name): 264 | i3.command("workspace %s" % name) 265 | 266 | 267 | def handle_workspace_focus(i3, i3_state, allowed_workspace, nagbar): 268 | def handler(self, e): 269 | if not allowed_workspace(e.current.num): 270 | activate_workspace(i3, i3_state["focused_workspace_name"]) 271 | if nagbar: 272 | show_message( 273 | "Workspace %s is not allowed during a pomodoro" % e.current.name 274 | ) 275 | i3_state["focused_workspace_name"] = e.current.name 276 | 277 | return handler 278 | 279 | 280 | def i3_daemon(disabled_during_pomodoro, nagbar): 281 | def generated_daemon(): 282 | workspace_policy = create_workspace_policy(disabled_during_pomodoro) 283 | i3 = i3ipc.Connection() 284 | i3_state = {"focused_workspace_name": get_focused_workspace(i3).name} 285 | i3.on( 286 | "workspace::focus", 287 | handle_workspace_focus(i3, i3_state, workspace_policy, nagbar), 288 | ) 289 | i3.main() 290 | 291 | return generated_daemon 292 | 293 | 294 | def pomodoro_daemon(): 295 | pomodoro = get_pomodoro_proxy() 296 | pomodoro.StateChanged.connect(handle_state) 297 | GLib.MainLoop().run() 298 | 299 | 300 | @click.command(help="Disable certain workspaces during pomodoro") 301 | @click.argument("workspaces_disabled_during_pomodoro", nargs=-1, type=int) 302 | @click.option("--nagbar/--no-nagbar", default=False) 303 | def daemon(workspaces_disabled_during_pomodoro, nagbar): 304 | daemon_commands = [ 305 | i3_daemon(workspaces_disabled_during_pomodoro, nagbar), 306 | pomodoro_daemon, 307 | ] 308 | threads = [Thread(target=command) for command in daemon_commands] 309 | for thread in threads: 310 | thread.daemon = True 311 | thread.start() 312 | 313 | for thread in threads: 314 | thread.join() 315 | 316 | 317 | main.add_command(status) 318 | main.add_command(pause) 319 | main.add_command(resume) 320 | main.add_command(start) 321 | main.add_command(stop) 322 | main.add_command(start_stop) 323 | main.add_command(skip) 324 | main.add_command(reset) 325 | main.add_command(toggle) 326 | main.add_command(daemon) 327 | 328 | if __name__ == "__main__": 329 | main() 330 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------