{"id":13467350,"url":"https://github.com/xflux-gui/fluxgui","last_synced_at":"2025-05-14T20:10:54.342Z","repository":{"id":6878770,"uuid":"55524946","full_name":"xflux-gui/fluxgui","owner":"xflux-gui","description":"Better lighting for Linux. Open source GUI for xflux","archived":false,"fork":false,"pushed_at":"2024-09-13T11:29:07.000Z","size":1649,"stargazers_count":2843,"open_issues_count":11,"forks_count":177,"subscribers_count":58,"default_branch":"master","last_synced_at":"2025-04-10T11:02:40.806Z","etag":null,"topics":["bluelight","eye-strain","indicator-applet","night","sleep-issues","ubuntu","xflux"],"latest_commit_sha":null,"homepage":"https://justgetflux.com/linux.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xflux-gui.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-04-05T16:42:49.000Z","updated_at":"2025-03-23T07:36:18.000Z","dependencies_parsed_at":"2024-09-13T23:11:43.794Z","dependency_job_id":"80c1548e-cc03-43bd-bf6f-dfb1131649f1","html_url":"https://github.com/xflux-gui/fluxgui","commit_stats":{"total_commits":309,"total_committers":36,"mean_commits":8.583333333333334,"dds":0.6440129449838188,"last_synced_commit":"69702cd59abcf292a7ff05fd0a4ba6851366435a"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xflux-gui%2Ffluxgui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xflux-gui%2Ffluxgui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xflux-gui%2Ffluxgui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xflux-gui%2Ffluxgui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xflux-gui","download_url":"https://codeload.github.com/xflux-gui/fluxgui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254219374,"owners_count":22034397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bluelight","eye-strain","indicator-applet","night","sleep-issues","ubuntu","xflux"],"created_at":"2024-07-31T15:00:55.311Z","updated_at":"2025-05-14T20:10:54.324Z","avatar_url":"https://github.com/xflux-gui.png","language":"Python","funding_links":[],"categories":["Python","Desktop Customization","ubuntu","my-ubuntu"],"sub_categories":["VoIP"],"readme":"THIS PACKAGE IS BARELY MAINTAINED\n======================\n\nYou should use [`redshift-gtk`](https://github.com/jonls/redshift) instead. That's what I use :)\n\nTHE INSTALLATION PROCESS IS BROKEN IN PYTHON VERSIONS AFTER 3.9\n======================\n\nSee [Issue #178](https://github.com/xflux-gui/fluxgui/issues/178).\n\nXFLUX DOES NOT WORK ON MOST MODERN SYSTEMS\n======================\n\nThe `xflux` program that Fluxgui traditionally used to change the\nscreen color hasn't worked on most modern systems since 2016, it's a\nclosed source program that is not part of this project, and there are\nno plans to fix it. Because of this, Fluxgui by default now uses\n[Redshift](http://jonls.dk/redshift/) to control your screen color,\nwhich should be supported on all systems.\n\nSee [Issue #27](https://github.com/xflux-gui/fluxgui/issues/27) for why `xflux` probably won't work on your system and\nhow to test if it can.\n\nf.lux indicator applet\n======================\n_Better lighting for your computer_\n\nThe f.lux indicator applet `fluxgui` is an indicator applet that uses\n`xflux` or `redshift` to make the color of your computer's display\nadapt to the time of day: warm at night, and like sunlight during the\nday. Reducing blue light exposure in the evening can help you fall\nasleep at night. See https://justgetflux.com/research.html or\nhttp://jonls.dk/redshift/ for more details.\n\nThis project -- https://github.com/xflux-gui/fluxgui -- is only\nconcerned with the `fluxgui` indicator applet program, not with the\nunderlying `xflux` or `redshift` program the indicator applet\ncontrols. The `xflux` or `redshift` program is responsible for\nactually changing the color of your screen. See\nhttps://justgetflux.com/linux.html for more information about `xflux`.\n\nThe `xflux` program is downloaded automatically when installing\n`fluxgui`. You can install `redshift` via the `redshift` package on\nmost Linux distros. Simply run `fluxgui` in your terminal after\ninstallation to open the applet.  You can also easily configure the\napplet to auto-start on login.\n\nInstall Instructions\n--------------------\n\n### Only Python 3 is Supported\n\nThe `fluxgui` is only known to work with Python 3.\n\n### Ubuntu PPA Package Manager Install\n\n***The [PPA](https://launchpad.net/~nathan-renniewaldock/+archive/ubuntu/flux) was last updated in 2019 (last supported Ubuntu version is 18.04 - bionic) and so you probably want to do a [manual install](#manual-install)!***\n\nTo install via apt:\n\n```bash\nsudo add-apt-repository ppa:nathan-renniewaldock/flux\nsudo apt-get update\nsudo apt-get install fluxgui\n```\nSee [ubuntuhandbook.org instructions](http://ubuntuhandbook.org/index.php/2016/03/install-f-lux-in-ubuntu-16-04/) for more details.\n\n#### Workaround for Ubuntu 20.04 LTS and above\nWhile `sudo apt-get update` there is an error [#144](https://github.com/xflux-gui/fluxgui/issues/144)\n```console\nE: The repository 'http://ppa.launchpad.net/nathan-renniewaldock/flux/ubuntu focal Release' does not have a Release file. \n```\nTo solve:\n1. `sudo vim /etc/apt/sources.list.d/nathan-renniewaldock-ubuntu-flux-focal.list`\n2. Replace `focal` with `bionic` or whatever distro you're using and save it.\n3. Repeat [above](#ubuntu-ppa-package-manager-install) mentioned steps from line 2. \n\n\nIf you have trouble with the PPA version try the manual install below.\n\n### Fedora Package Manager Install\n\nThere is no Fedora package provided yet. Please use [Manual Install](#manual-install) below.\n\n### Manual Install\n\nTo install manually you first install the dependencies using your package manager, and then install `fluxgui` using the provided `setup.py`. The manual install can be done locally or system wide.\n\n#### Install Dependencies Using Package Manager\n\nFor the `appindicator` implementation, both plain `appindicator` and the Ayatana `ayatanaappindicator` are supported.\n\n##### Ubuntu/Debian\n\nPartial list of Python 3 dependencies (after the upgrade to GTK+ 3 in PR #112. If you discover the correct deps, please submit a PR):\n\n```bash\nsudo apt-get install python3-pexpect python3-distutils python3-xdg gir1.2-ayatanaappindicator3-0.1 gir1.2-gtk-3.0 redshift\n```\n\nAccording to [this comment]( https://github.com/xflux-gui/fluxgui/issues/176#issuecomment-2295441326), these deps may also be needed:\n\n```bash\ngir1.2-appindicator3-0.1 python3-gi python3-gi-cairo\n```\n\nOut of date Python 2 dependencies; the remaining Python 3 deps should be similar:\n\n```bash\nsudo apt-get install git python-gconf python-gtk2 python-glade2 libxxf86vm1 libcanberra-gtk-module\n```\n\n##### Fedora/CentOS\n\nWARNING: these dependencies may be out of date after the upgrade to GTK+ 3 in PR #112. If you discover the correct deps, please submit a PR.\n\n```bash\nsudo yum install git python-appindicator python2-pyxdg python3-pexpect gnome-python2-gconf pygtk2 pygtk2-libglade redshift\n```\n\n#### Install `fluxgui`\n\nThere are separate instructions in the code below for installing system wide and for installing locally in your user directory; choose one.\n\n```bash\n# Download fluxgui\ncd /tmp\ngit clone \"https://github.com/xflux-gui/fluxgui.git\"\ncd fluxgui\n./download-xflux.py\n\n# EITHER install system wide\nsudo ./setup.py install --record installed.txt\n\n# EXCLUSIVE OR, install in your home directory\n#\n# The fluxgui program installs\n# into ~/.local/bin, so be sure to add that to your PATH if installing\n# locally. In particular, autostarting fluxgui in Gnome will not work\n# if the locally installed fluxgui is not on your PATH.\n./setup.py install --user --record installed.txt\n       \n# Run flux\nfluxgui\n```\n\n### Manual Uninstall\n\nIf you manually installed instead of using package manager, you can uninstall\nby making `setup.py` tell you where it installed files and then\nremoving the installed files.\n\n```bash\n# EITHER uninstall globally\n#\n# The 'installed.txt' is generated when you install. Reinstall first if you\n# as described above if you don't have an 'installed.txt' file.\nsudo xargs rm -vr \u003c installed.txt\nsudo glib-compile-schemas \"$(dirname \"$(grep apps.fluxgui.gschema.xml installed.txt)\")\"\n\n# EXCLUSIVE OR uninstall in your home directory\nxargs rm -vr \u003c installed.txt\nglib-compile-schemas \"$(dirname \"$(grep apps.fluxgui.gschema.xml installed.txt)\")\"\n```\n\nLicense\n-------\n\nThe `fluxgui` applet is released under the [MIT License](https://github.com/xflux-gui/fluxgui/blob/master/LICENSE). The underlying `xflux` program that actually controls the screen color is closed source.\n\nDeveloping\n----------\n\n### Coding Style\n\nTry to stick to the same coding style that is already used in the file you are editing.\nIn particular, don't change the style of code you're not already editing for some other\nreason. Style changes create noise in the Git history and make the `git blame` output\nmisleading. When reviewing a PR, the maintainers want to focus on the logical changes\nintroduced by your code, and extraneous style changes make that harder.\n\n### Running `fluxgui` Without Installing\n\nWhen working on `fluxgui`, you can use\n```bash\ncd \u003cpath to your fluxgui.git clone\u003e\n# You only need to download xflux once.\n./download-xflux.py\nglib-compile-schemas .\nGSETTINGS_SCHEMA_DIR=`pwd` PATH=`pwd`:$PATH PYTHONPATH=`pwd`/src:$PYTHONPATH ./fluxgui\n```\nto test your local copy of `fluxgui` without installing anything.\n\n### Change Logs, Versions, Releases\n\nNote changes in `./debian/changelog`.\n\nUse version `\u003cver\u003epre` until ready to release a version. When\nreleasing a version remove the `pre` suffix from the version strings\nand commit, copying the changelog changes for the current release into\nthe commit message. Then `git tag -a v\u003cver\u003e`, using the commit msg for\nthe tag annotation, and push the version tag with `git push origin\nv\u003cver\u003e`. Finally, create another commit with the new `\u003cnext\nversion\u003epre` version strings and changelog entry.\n\nWhen releasing the version string needs to be changed in\n`debian/changelog` and `setup.py`, and the release dates needs to be\nadded in `debian/changelog`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxflux-gui%2Ffluxgui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxflux-gui%2Ffluxgui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxflux-gui%2Ffluxgui/lists"}