2016-12-10 20:05:02 +01:00
# bumblebee-status
2016-12-11 13:50:33 +01:00
[](https://travis-ci.org/tobi-wan-kenobi/bumblebee-status)
[](https://codeclimate.com/github/tobi-wan-kenobi/bumblebee-status)
[](https://codeclimate.com/github/tobi-wan-kenobi/bumblebee-status/coverage)
[](https://codeclimate.com/github/tobi-wan-kenobi/bumblebee-status)
2016-12-10 20:05:02 +01:00
2017-09-07 16:22:30 +02:00
**Many, many thanks to all contributors! As of now, 21 of the modules are from various contributors (!), and only 16 from myself.**
2017-06-12 19:00:17 +02:00
2016-12-10 20:05:02 +01:00
bumblebee-status is a modular, theme-able status line generator for the [i3 window manager ](https://i3wm.org/ ).
Focus is on:
* Ease of use (no configuration files!)
* Theme support
* Extensibility (of course...)
2017-08-02 19:34:54 +02:00
One thing I like in particular: You can use the mouse wheel up/down to switch workspaces forward and back everywhere throughout the bar (unless you have mapped the mouse wheel buttons to another action for a widget, in which case this doesn't work while hovering that particular widget).
2016-12-10 20:05:02 +01:00
I hope you like it and appreciate any kind of feedback: Bug reports, Feature requests, etc. :)
Thanks a lot!
2017-02-25 07:54:03 +01:00
Supported Python versions: 2.7, 3.3, 3.4, 3.5, 3.6
Explicitly unsupported Python versions: 3.2 (missing unicode literals)
2016-12-10 20:05:02 +01:00
# Documentation
See [the wiki ](https://github.com/tobi-wan-kenobi/bumblebee-status/wiki ) for documentation.
Other resources:
* A list of [available modules ](https://github.com/tobi-wan-kenobi/bumblebee-status/wiki/Available-Modules )
* [How to write a theme ](https://github.com/tobi-wan-kenobi/bumblebee-status/wiki/How-to-write-a-theme )
* [How to write a module ](https://github.com/tobi-wan-kenobi/bumblebee-status/wiki/How-to-write-a-module )
# Installation
```
$ git clone git://github.com/tobi-wan-kenobi/bumblebee-status
```
# Usage
2017-04-02 08:34:17 +02:00
## Normal usage
2017-08-20 10:59:39 +02:00
In your i3wm configuration, modify the *status_command* for your i3bar like this:
2016-12-10 20:05:02 +01:00
```
bar {
status_command = < path to bumblebee-status / bumblebee-status > -m < list of modules > -p < list of module parameters > -t < theme >
}
```
You can retrieve a list of modules and themes by entering:
```
$ cd bumblebee-status
$ ./bumblebee-status -l themes
$ ./bumblebee-status -l modules
```
2017-08-20 10:59:39 +02:00
Any parameter you can specify with `-p <name>=<value>` , you can alternatively specify in `~/.bumblebee-status.conf` or `~/.config/bumblebee-status.conf` . This parameters act as a **fallback** , so values specified with `-p` have priority.
2017-07-12 18:42:02 +02:00
Configuration files have a format like this:
```
$ cat ~/.bumblebee-status.conf
[module-parameters]
< key > = < value >
```
For example:
```
$ cat ~/.bumblebee-status.conf
[module-parameters]
github.token=abcdefabcdef12345
```
2017-03-16 21:04:24 +01:00
To change the update interval, use:
```
$ ./bumblebee-status -m < list of modules > -p interval=< interval in seconds >
```
2016-12-10 20:05:02 +01:00
As a simple example, this is what my i3 configuration looks like:
```
bar {
font pango:Inconsolata 10
position top
tray_output none
2016-12-11 13:12:22 +01:00
status_command ~/.i3/bumblebee-status/bumblebee-status -m nic disk:root cpu memory battery date time pasink pasource dnf -p root.path=/ time.format="%H:%M CW %V" date.format="%a, %b %d %Y" -t solarized-powerline
2016-12-10 20:05:02 +01:00
}
```
Restart i3wm and - that's it!
2017-04-02 08:34:17 +02:00
## Errors
If errors occur, you should see them in the i3bar itself. If that does not work, or you need more information for troubleshooting, you can activate a debug log using the `-d` or `--debug` switch:
```
$ ./bumblebee-status -d -m < list of modules >
```
2017-07-08 08:11:52 +02:00
This will create a file called `~/bumblebee-status-debug.log` by default. The file name can be changed by using the `-f` or `--logfile` option.
2017-04-02 08:34:17 +02:00
2017-02-26 08:28:30 +01:00
# Required Modules
Modules and commandline utilities are only required for modules, the core itself has no external dependencies at all.
2017-04-23 07:24:36 +02:00
* psutil (for the modules 'cpu', 'memory', 'traffic')
2017-07-07 19:03:54 +02:00
* netifaces (for the modules 'nic', 'traffic')
* requests (for the modules 'weather', 'github', 'getcrypto', 'stock')
2017-08-04 10:41:37 +02:00
* power (for the module 'battery')
2017-08-04 10:47:05 +02:00
* dbus (for the module 'spotify')
2017-02-26 08:28:30 +01:00
# Required commandline utilities
* xset (for the module 'caffeine')
* notify-send (for the module 'caffeine')
* cmus-remote (for the module 'cmus')
* dnf (for the module 'dnf')
* gpmdp-remote (for the module 'gpmdp')
* setxkbmap (for the module 'layout')
* fakeroot (for the module 'pacman')
* pacman (for the module 'pacman')
* pactl (for the module 'pulseaudio')
* ping (for the module 'ping')
* redshift (for the module 'redshift')
* xrandr (for the module 'xrandr')
2017-05-26 19:48:23 +02:00
* mpc (for the module 'mpd')
2017-06-01 18:27:03 +02:00
* bluez / blueman (for module 'bluetooth')
* dbus-send (for module 'bluetooth')
2017-06-11 14:45:14 +02:00
* nvidia-smi (for module 'nvidiagpu')
2017-07-22 11:44:21 +02:00
* sensors (for module 'sensors', as fallback)
2016-12-10 20:05:02 +01:00
# Examples
Here are some screenshots for all themes that currently exist:
2017-04-22 07:43:31 +02:00
:exclamation: Some themes (all 'Powerline' themes) require [Font Awesome ](http://fontawesome.io/ ) and a powerline-compatible font ([powerline-fonts](https://github.com/powerline/fonts), for example) to display all icons correctly.
2017-02-24 18:28:27 +01:00
2016-12-10 20:05:02 +01:00
Gruvbox Powerline (`-t gruvbox-powerline`) (contributed by [@paxy97 ](https://github.com/paxy97 )):
Solarized Powerline (`-t solarized-powerline`):
2017-04-21 07:23:43 +02:00
Gruvbox (`-t gruvbox`):
2016-12-10 20:05:02 +01:00
Solarized (`-t solarized`):
Powerline (`-t powerline`):
Default (nothing or `-t default` ):
