9cd9ff626d
first, this fixes #607 also, i think it slightly simplifies code to make "simple" stuff like names, etc. attributes instead of methods all the time. so, expect this to be extended to other components, as well. |
||
|---|---|---|
| .github | ||
| bin | ||
| core | ||
| doc | ||
| modules | ||
| tests | ||
| themes | ||
| util | ||
| .codeclimate.yml | ||
| .coveragerc | ||
| .gitignore | ||
| .travis.yml | ||
| __init__.py | ||
| bumblebee-status | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| coverage.sh | ||
| LICENSE | ||
| README.md | ||
bumblebee-status
Many, many thanks to all contributors! All of the really cool modules have been contributed by somebody else :)
bumblebee-status is a modular, theme-able status line generator for the i3 window manager.
Focus is on:
- Ease of use
- Support for easily adding custom themes
- Support for easily adding custom modules
I hope you like it and I appreciate any kind of feedback: Bug reports, feature requests, etc. :)
Thanks a lot!
Required i3wm version: 4.12+ (in earlier versions, blocks won't have background colors)
Supported Python versions: 3.4, 3.5, 3.6, 3.7, 3.8
Supported FontAwesome version: 4 (free version of 5 doesn't include some of the icons)
Example usage:
bar {
status_command <path>/bumblebee-status -m cpu memory battery time pasink pasource -p time.format="%H:%M" -t solarized
}
Documentation
See the docs for documentation.
See FAQ for FAQs.
Other resources:
Installation
$ git clone git://github.com/tobi-wan-kenobi/bumblebee-status
Dependencies
Available modules lists the dependencies (Python modules and external executables) for each module. If you are not using a module, you don't need the dependencies.
Usage
Normal usage
In your i3wm configuration, modify the status_command for your i3bar like this:
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 their parameters) and themes by entering:
$ cd bumblebee-status
$ ./bumblebee-status -l themes
$ ./bumblebee-status -l modules
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.
Parameters can also be used to override theme settings, such as:
$ ./bumblebee-status -p <module>.theme.<theme field>=<value>
# for example, to get a spacer with a red background:
$ ./bumblebee-status -m spacer -p spacer.theme.bg=#ff0000
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
To change the update interval, use:
$ ./bumblebee-status -m <list of modules> -p interval=<interval in seconds>
As a simple example, this is what my i3 configuration looks like:
bar {
font pango:Inconsolata 10
position top
tray_output none
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
}
Restart i3wm and - that's it!
