| Name | flashfocus JSON |
| Version |
2.4.1
JSON |
| download |
| home_page | |
| Summary | Simple focus animations for tiling window managers. |
| upload_time | 2023-09-24 23:26:20 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) 2018 Fenner Macrae Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
xorg
x11
flash
focus
i3
sway
wlroots
bspwm
awesomewm
herbsluftwm
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# flashfocus
Simple focus animations for tiling window managers.
<br>
Compatible with sway as well as all X based window managers (i3, bspwm, awesome-wm, xmonad...).
Flashfocus is currently pretty stable and I don't have any major features in
the works, however the project is still actively maintained and feature
requests are always welcome :)
## Installation
For X based window managers, an active window compositor is required for the effects of flashfocus
to be noticeable. If you don't have one setup already, I recommend
[picom](https://github.com/yshui/picom).
### Arch
Install from the Arch User Repository: `flashfocus`
### Ubuntu/Debian
```
sudo apt-get install libxcb-render0-dev libffi-dev python-dev python-cffi
pip install flashfocus
```
### Fedora
```
dnf install libffi-devel python-devel python-cffi
pip install flashfocus
```
### openSUSE
Flashfocus is in the official repository of openSUSE Tumbleweed.
openSUSE Leap users can install it from the [X11:Utilities](https://build.opensuse.org/package/show/X11%3AUtilities/flashfocus) devel project:
```
zypper ar obs://X11:Utilities x11util
zypper ref
zypper in flashfocus
```
### Nix / NixOS
Declaratively in `/etc/nixos/configuration.nix`
```
environment.systemPackages = with pkgs; [
flashfocus
];
```
Ad hoc
```
nix-env -iA nixpkgs.flashfocus
```
## Quickstart
#### Picom setup
The following must be present in your picom config file:
```
detect-client-opacity = true;
```
If you use i3, the following is also required for flashfocus to work with tabbed containers:
```
opacity-rule = [
"0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'"
];
```
#### Running flashfocus
Flashfocus should be added to your startup programs. E.g for i3 place the
following in your config:
```
exec_always --no-startup-id flashfocus
```
The `flash_window` script can be used to flash the current window on key-press. E.g if you'd like to bind to mod+n in i3:
```
bindsym $mod+n exec --no-startup-id flash_window
```
## Configuration
Flashfocus can be configured via its config file or with command line parameters. Some features, such as window-specific flash customization, are only available through the config file.
The config file is searched for in the following locations:
1. $XDG_CONFIG_HOME/flashfocus/flashfocus.yml
2. ~/.config/flashfocus/flashfocus.yml
3. ~/.flashfocus.yml
When flashfocus is first run it creates a default config file in 1. or 2. Documentation of all configuration options is present in the config file.
See the [wiki](https://github.com/fennerm/flashfocus/wiki) for some extra docs.
Raw data
{
"_id": null,
"home_page": "",
"name": "flashfocus",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "xorg,x11,flash,focus,i3,sway,wlroots,bspwm,awesomewm,herbsluftwm",
"author": "",
"author_email": "Fenner Macrae <fmacrae.dev@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/d2/c5/767d8c593b1a423849115ed150904459a33f46756b955067cb11f70264e9/flashfocus-2.4.1.tar.gz",
"platform": null,
"description": "# flashfocus\n\nSimple focus animations for tiling window managers.\n\n\n\n<br>\n\nCompatible with sway as well as all X based window managers (i3, bspwm, awesome-wm, xmonad...).\n\n\nFlashfocus is currently pretty stable and I don't have any major features in\nthe works, however the project is still actively maintained and feature\nrequests are always welcome :)\n\n## Installation\n\nFor X based window managers, an active window compositor is required for the effects of flashfocus\nto be noticeable. If you don't have one setup already, I recommend\n[picom](https://github.com/yshui/picom).\n\n### Arch\n\nInstall from the Arch User Repository: `flashfocus`\n\n### Ubuntu/Debian\n\n```\nsudo apt-get install libxcb-render0-dev libffi-dev python-dev python-cffi\npip install flashfocus\n```\n\n### Fedora\n\n```\ndnf install libffi-devel python-devel python-cffi\npip install flashfocus\n```\n\n### openSUSE\nFlashfocus is in the official repository of openSUSE Tumbleweed.\nopenSUSE Leap users can install it from the [X11:Utilities](https://build.opensuse.org/package/show/X11%3AUtilities/flashfocus) devel project:\n\n```\nzypper ar obs://X11:Utilities x11util\nzypper ref\nzypper in flashfocus\n```\n\n### Nix / NixOS\n\nDeclaratively in `/etc/nixos/configuration.nix`\n\n```\nenvironment.systemPackages = with pkgs; [\n flashfocus\n];\n```\n\nAd hoc\n\n```\nnix-env -iA nixpkgs.flashfocus\n```\n\n## Quickstart\n\n#### Picom setup\n\nThe following must be present in your picom config file:\n\n```\ndetect-client-opacity = true;\n```\n\nIf you use i3, the following is also required for flashfocus to work with tabbed containers:\n\n```\nopacity-rule = [\n \"0:_NET_WM_STATE@:32a *= '_NET_WM_STATE_HIDDEN'\"\n];\n```\n\n#### Running flashfocus\n\nFlashfocus should be added to your startup programs. E.g for i3 place the\nfollowing in your config:\n\n```\nexec_always --no-startup-id flashfocus\n```\n\nThe `flash_window` script can be used to flash the current window on key-press. E.g if you'd like to bind to mod+n in i3:\n\n```\nbindsym $mod+n exec --no-startup-id flash_window\n```\n\n## Configuration\n\nFlashfocus can be configured via its config file or with command line parameters. Some features, such as window-specific flash customization, are only available through the config file.\n\nThe config file is searched for in the following locations:\n1. $XDG_CONFIG_HOME/flashfocus/flashfocus.yml\n2. ~/.config/flashfocus/flashfocus.yml\n3. ~/.flashfocus.yml\n\nWhen flashfocus is first run it creates a default config file in 1. or 2. Documentation of all configuration options is present in the config file.\n\nSee the [wiki](https://github.com/fennerm/flashfocus/wiki) for some extra docs.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018 Fenner Macrae Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple focus animations for tiling window managers.",
"version": "2.4.1",
"project_urls": null,
"split_keywords": [
"xorg",
"x11",
"flash",
"focus",
"i3",
"sway",
"wlroots",
"bspwm",
"awesomewm",
"herbsluftwm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "925c84d7cd4ae3d5f4119270042dd7a96b2c06dcecdda45476e5a04d0159926d",
"md5": "636d342531e8b9b55e6f46aeae7235d6",
"sha256": "c7bd0237cf40a7f89242858e228ecf7b0930b2d7d58c938ac6c9e05f8a4ba09c"
},
"downloads": -1,
"filename": "flashfocus-2.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "636d342531e8b9b55e6f46aeae7235d6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 29309,
"upload_time": "2023-09-24T23:26:18",
"upload_time_iso_8601": "2023-09-24T23:26:18.186755Z",
"url": "https://files.pythonhosted.org/packages/92/5c/84d7cd4ae3d5f4119270042dd7a96b2c06dcecdda45476e5a04d0159926d/flashfocus-2.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d2c5767d8c593b1a423849115ed150904459a33f46756b955067cb11f70264e9",
"md5": "90763b0faa8badf7178acc78dae499e2",
"sha256": "3ba8d143a7bde9bf02bae9930fa4c610b6b3dba368ed61598064a735296acee1"
},
"downloads": -1,
"filename": "flashfocus-2.4.1.tar.gz",
"has_sig": false,
"md5_digest": "90763b0faa8badf7178acc78dae499e2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 24732,
"upload_time": "2023-09-24T23:26:20",
"upload_time_iso_8601": "2023-09-24T23:26:20.029511Z",
"url": "https://files.pythonhosted.org/packages/d2/c5/767d8c593b1a423849115ed150904459a33f46756b955067cb11f70264e9/flashfocus-2.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-24 23:26:20",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "flashfocus"
}
