diff --git a/README.md b/README.md index 2d46c94..34ee4f3 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,48 @@ + + # i3pystatus i3pystatus is a (hopefully growing) collection of python scripts for status output compatible to i3status / i3bar of the i3 window manager. -## Version 3 - -Version 3 has been merged into master recently, please check out if your config still works, -as many modules have been reworked (mostly added options) and the new settings system is in-place. -For examples how it works, take a look at the __main__.py.dist file with some examples. - ## Installation -To install it, follow these steps: +### From PyPI package [i3pystatus](https://pypi.python.org/pypi/i3pystatus) - cd ~/.config/i3status/ - git clone git@github.com:enkore/i3pystatus contrib - cd contrib/i3pystatus - cp __main__.py.dist __main__.py + pip install i3pystatus -Add the following to `~/.config/i3status/config`: +### Packages for your OS - general { - output_format = "i3bar" - colors = true - interval = 5 - } + * [Arch Linux](https://aur.archlinux.org/packages/i3pystatus-git/) -Change your i3wm config to the following: +## Configuration + +You can keep your config file at various places, i3pystatus will look +for it in these places: + + ~/.i3pystatus.py + ~/.i3/i3pystatus.py + ~/.config/i3pystatus.py + $XDG_CONFIG_HOME/i3pystatus.py + /etc/i3pystatus.py + /etc/xdg/i3pystatus.py + $XDG_CONFIG_DIRS/i3pystatus.py + +A sample configuration file is `i3pystatus/__main__.py.dist` + +Also change your i3wm config to the following: # i3bar bar { - status_command cd ~/.config/i3status/contrib ; i3status | python -m i3pystatus + status_command i3pystatus position top workspace_buttons yes } -And finally adjust the settings in `~/.config/i3status/contrib/i3pystatus/__main__.py` -as you like. - ## Modules Many modules let you modify the output via a @@ -198,10 +203,10 @@ The `backends` setting determines the backends to use. Currently available are: > > > * `host` — (required) -> * `port` — (default: `143`) +> * `port` — (default: `993`) > * `username` — (required) > * `password` — (required) -> * `ssl` — (default: `False`) +> * `ssl` — (default: `True`) > > > @@ -303,9 +308,11 @@ Simple regex file watcher ### runwatch -Expands the given path using glob to a pidfile and checks if the process ID found inside is valid +Expands the given path using glob to a pidfile and checks +if the process ID found inside is valid (that is, if the process is running). -You can use this to check if a specific application, such as a VPN client or your DHCP client is running. +You can use this to check if a specific application, +such as a VPN client or your DHCP client is running. Available formatters are {pid} and {name}. @@ -371,3 +378,4 @@ a python class that can be registered with the `I3statusHandler` class. Also don forget to add yourself to the LICENSE file. **Patches and pull requests are very welcome :-)** + diff --git a/README.tpl.md b/README.tpl.md index dbce4fc..5aae38e 100644 --- a/README.tpl.md +++ b/README.tpl.md @@ -1,43 +1,48 @@ + + # i3pystatus i3pystatus is a (hopefully growing) collection of python scripts for status output compatible to i3status / i3bar of the i3 window manager. -## Version 3 - -Version 3 has been merged into master recently, please check out if your config still works, -as many modules have been reworked (mostly added options) and the new settings system is in-place. -For examples how it works, take a look at the __main__.py.dist file with some examples. - ## Installation -To install it, follow these steps: +### From PyPI package [i3pystatus](https://pypi.python.org/pypi/i3pystatus) - cd ~/.config/i3status/ - git clone git@github.com:enkore/i3pystatus contrib - cd contrib/i3pystatus - cp __main__.py.dist __main__.py + pip install i3pystatus -Add the following to `~/.config/i3status/config`: +### Packages for your OS - general { - output_format = "i3bar" - colors = true - interval = 5 - } + * [Arch Linux](https://aur.archlinux.org/packages/i3pystatus-git/) -Change your i3wm config to the following: +## Configuration + +You can keep your config file at various places, i3pystatus will look +for it in these places: + + ~/.i3pystatus.py + ~/.i3/i3pystatus.py + ~/.config/i3pystatus.py + $XDG_CONFIG_HOME/i3pystatus.py + /etc/i3pystatus.py + /etc/xdg/i3pystatus.py + $XDG_CONFIG_DIRS/i3pystatus.py + +A sample configuration file is `i3pystatus/__main__.py.dist` + +Also change your i3wm config to the following: # i3bar bar { - status_command cd ~/.config/i3status/contrib ; i3status | python -m i3pystatus + status_command i3pystatus position top workspace_buttons yes } -And finally adjust the settings in `~/.config/i3status/contrib/i3pystatus/__main__.py` -as you like. - ## Modules Many modules let you modify the output via a diff --git a/i3pystatus/mkdocs.py b/i3pystatus/mkdocs.py index 1ed34c7..8f13dbc 100755 --- a/i3pystatus/mkdocs.py +++ b/i3pystatus/mkdocs.py @@ -11,7 +11,7 @@ import i3pystatus.mail from .core.imputil import ClassFinder -IGNORE = ("__main__", "mkdocs") +IGNORE = ("__main__", "mkdocs", "core") MODULE_FORMAT = """ {heading} {name} diff --git a/mkdocs.sh b/mkdocs.sh deleted file mode 100755 index aae78a3..0000000 --- a/mkdocs.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/bin/sh - -python -m i3pystatus.mkdocs -