/xflux-gui

Better lighting for Linux. Open source GUI for xflux

Primary LanguagePythonOtherNOASSERTION

f.lux indicator applet

Better lighting for your computer

The f.lux indicator applet fluxgui is an indicator applet to control xflux, an application that makes the color of your computer's display adapt to the time of day, warm at nights and like sunlight during the day. Reducing blue light exposure in the evening can help you fall asleep at night. See https://justgetflux.com/research.html for more details.

This project -- https://github.com/xflux-gui/xflux-gui -- is only concerned with the fluxgui indicator applet program, not with the underlying xflux program the indicator applet controls. The xflux program is responsible for actually changing the color of your screen. See https://justgetflux.com/linux.html for more information about xflux.

Install Instructions

Ubuntu PPA Package Manager Install

There is a PPA here:

https://launchpad.net/~nathan-renniewaldock/+archive/ubuntu/flux

See ubuntuhandbook.org instructions for more details on using the PPA to install xflux using the package manager.

If you have trouble with the PPA version try the manual install below.

Ubuntu/Debian Manual Install

# Install dependencies
sudo apt-get install git python-appindicator python-xdg python-pexpect python-gconf python-gtk2 python-glade2 libxxf86vm1

# Download xflux-gui
cd /tmp
git clone "https://github.com/xflux-gui/xflux-gui.git"
cd xflux-gui
python download-xflux.py

# EITHER install globally
sudo python setup.py install
# OR, install in your home directory
python setup.py install --user

# Run flux
fluxgui

# To uninstall:
sudo rm -rf /usr/local/lib/python2.7/dist-packages/{fluxgui/,f.lux_indicator*}
sudo rm /usr/local/share/icons/hicolor/scalable/apps/fluxgui.*
sudo rm /usr/local/share/applications/fluxgui.desktop
sudo rm /usr/local/bin/{xflux,fluxgui}
rm -rf ~/.gconf/apps/fluxgui/

License

The f.lux indicator applet is released under the MIT License.

Developing

When working on fluxgui, you can use

cd <path to your xflux-gui.git clone>
# You only need to download xflux once.
python download-xflux.py
PATH=`pwd`:$PATH PYTHONPATH=`pwd`/src:$PYTHONPATH ./fluxgui &

to test your local copy of fluxgui without installing anything.