Wakepy

🗓️ 2024-09-20

🐞 Bug fixes
- Fix the wakepy logo/text printed to CLI ([400](https://github.com/fohrloop/wakepy/pull/400))

**diff: [v0.10.0...v0.10.1](https://github.com/fohrloop/wakepy/compare/v0.10.0...v0.10.1)**

🗓️ 2024-09-20

🏆 Highlights
- Wakepy has been available in conda-forge since 0.9.1. Now it’s also documented.
- Warn instead of raise Exception by default if activating a Mode fails.

✨ Features
- Change default on_fail action to be “warn” instead of “error” (in [keep.running](https://wakepy.readthedocs.io/0.10.0/api-reference.html#wakepy.keep.running) and [keep.presenting](https://wakepy.readthedocs.io/0.10.0/api-reference.html#wakepy.keep.presenting) modes). ([388](https://github.com/fohrloop/wakepy/pull/388))
- Add support for BSD and other non-Linux Unix-like FOSS desktop systems. All systems running a supported Desktop Environment (currently: KDE, Gnome + other freedesktop compliant DEs) should be supported. ([379](https://github.com/fohrloop/wakepy/pull/379), [#385](https://github.com/fohrloop/wakepy/pull/385))
- Add support for PyPy ([393](https://github.com/fohrloop/wakepy/pull/393), [#396](https://github.com/fohrloop/wakepy/pull/396))
- When running on an unknown platform, do not fail any Methods in the platform check phase anymore, but try to use each Method. This means for example that any system running GNOME that is not Linux (or BSD) could still use wakepy with the [org.gnome.SessionManager](https://wakepy.readthedocs.io/0.10.0/methods-reference.html#org-gnome-sessionmanager) ([379](https://github.com/fohrloop/wakepy/pull/379))
- 🚨 CLI arguments: Change -k, --keep-running to be -r, --keep-running and -p, --presentation to be -p, --keep-presenting; Be more consistent with the naming of the [Modes](https://wakepy.readthedocs.io/0.10.0/modes.html#wakepy-modes). The old alternatives are deprecated and will be removed in a future release. ([356](https://github.com/fohrloop/wakepy/pull/356))
- 🚨 Renamed [PlatformName](https://wakepy.readthedocs.io/v0.9.0.post1/api-reference.html#wakepy.core.constants.PlatformName) to [PlatformType](https://wakepy.readthedocs.io/v0.10.0/api-reference.html#wakepy.core.constants.PlatformType) and added new types: ANY, which means “any platform”, BSD, meaning “any BSD system” in the future, but currently just FreeBSD / GhostBSD, and UNIX_LIKE_FOSS, which means “Unix-like desktop environment, but FOSS”. Includes: Linux and BSD. Excludes: Android (mobile), MacOS (non-FOSS), ChromeOS (non-FOSS). Only affects you if you have created custom [Method](https://wakepy.readthedocs.io/v0.9.0.post1/api-reference.html#wakepy.Method) subclasses. ([379](https://github.com/fohrloop/wakepy/pull/379))
- Improve warnings and errors if platform is not supported ([383](https://github.com/fohrloop/wakepy/pull/383))

👷 Maintenance
- Fixed GitHub Release pipeline: Creates releases only from tags. Added automatic titles. Cannot accidentally publish with “main” tag. ([328](https://github.com/fohrloop/wakepy/pull/328), [#346](https://github.com/fohrloop/wakepy/pull/346))
- Fixed: Tests failing on Fedora 40 ([381](https://github.com/fohrloop/wakepy/pull/381))
- Update various development time dependencies ([389](https://github.com/fohrloop/wakepy/pull/389))

📖 Documentation
- Update Installing instructions. Wakepy is available in conda-forge starting from version 0.9.1. ([390](https://github.com/fohrloop/wakepy/pull/390) + Thanks to [thewchan](https://github.com/thewchan) for [wakepy-feedstock](https://github.com/conda-forge/wakepy-feedstock))
- Add Roadmap and improve the Supported Platforms docs ([365](https://github.com/fohrloop/wakepy/pull/365))
- Add logos and banners ([370](https://github.com/fohrloop/wakepy/pull/370), [#371](https://github.com/fohrloop/wakepy/pull/371))

**diff: [v0.9.1...v0.10.0](https://github.com/fohrloop/wakepy/compare/v0.9.1...v0.10.0)**

🗓️ 2024-06-04

🐞 Bug fixes
- The [SetThreadExecutionState](https://wakepy.readthedocs.io/stable/methods-reference.html#windows-stes) Method may now have multiple modes (same or different) activated within the same python thread without them interfering with each other on activation or deactivation, as wakepy creates a separate worker thread for the single purpose of setting and keeping the thread execution flag each time you activate a mode with the SetThreadExecutionState wakepy.Method. (342)
- Importing wakepy (0.8.0 and 0.9.0) messed up logging. In particular, the logging level was changed to WARNING due to direct call to logging.debug() instead of logger.debug(). (344). Thanks to reidswanson for reporting it.
- 👷 Fixed running the dev command inv test on Windows (339, 341)

🗓️ 2024-06-01

📖 Documentation
- Update docs and README after 0.8.0 & 0.9.0 releases ([331](https://github.com/fohrloop/wakepy/pull/331))

🗓️ 2024-05-31

✨ Features
- Support keep.running mode in KDE Plasma 5.12.90 and newer through the [org.freedesktop.PowerManagement](https://wakepy.readthedocs.io/v0.9.0/methods-reference.html#keep-running-org-freedesktop-powermanagement) method. It may also be used on other DEs which implement this older freedesktop.org D-Bus interface (but not Xcfe). ([324](https://github.com/fohrloop/wakepy/pull/324))
- Cooler CLI spinner ([309](https://github.com/fohrloop/wakepy/pull/309), [#323](https://github.com/fohrloop/wakepy/pull/323))

📖 Documentation
- Document that the [org.freedesktop.ScreenSaver](https://wakepy.readthedocs.io/v0.9.0/methods-reference.html#keep-presenting-org-freedesktop-screensaver) method for keep.presenting mode also supports KDE Plasma. ([324](https://github.com/fohrloop/wakepy/pull/324))
- Update dev docs ([308](https://github.com/fohrloop/wakepy/pull/308))
- Mention that shell should be restarted for wakepy CLI tool ([321](https://github.com/fohrloop/wakepy/pull/321))
- Fix: Supported Platforms table background does not support dark mode ([316](https://github.com/fohrloop/wakepy/pull/316))

🗓️ 2024-05-26

🏆 Highlights
- This is a basically a complete rewrite of wakepy. It adds support for keep.running mode on Gnome, on-fail action, possibility to control the used methods and their priority, more information about the used methods and the activation process and possibility to exit the mode early. In addition, testing and CI pipelines were updated to ease maintenance.

✨ Features
- Modes support [on-fail actions](https://wakepy.readthedocs.io/v0.8.0/user-guide.html#on-fail-action) (“error”, “warn”, “pass” or a callable). ([182](https://github.com/fohrloop/wakepy/pull/182))
- It is now possible to [select the used wakepy.Methods](https://wakepy.readthedocs.io/v0.8.0/user-guide.html#how-to-white-or-blacklist-methods) with methods and omit and to [change the priority order](https://wakepy.readthedocs.io/v0.8.0/user-guide.html#how-to-control-order-of-methods) of methods with methods_priority. ([75](https://github.com/fohrloop/wakepy/issues/75))
- Added [org.gnome.SessionManager](https://wakepy.readthedocs.io/v0.8.0/methods-reference.html#keep-running-org-gnome-sessionmanager) method which adds support for keep.running mode for users with Gnome Desktop Environment. ([51](https://github.com/fohrloop/wakepy/pull/51), [#138](https://github.com/fohrloop/wakepy/pull/138), [#278](https://github.com/fohrloop/wakepy/pull/278), [#282](https://github.com/fohrloop/wakepy/pull/282))
- [ActivationResult](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.ActivationResult) objects ([57](https://github.com/fohrloop/wakepy/pull/57), [#258](https://github.com/fohrloop/wakepy/pull/258), [#270](https://github.com/fohrloop/wakepy/pull/270)) in [Mode.activation_result](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.Mode.activation_result) which give more detailed information about the activation process.
- Possibility to exit from a mode context manager early with [ModeExit](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.ModeExit) ([72](https://github.com/fohrloop/wakepy/pull/72))
- It’s now possible to check the active and used method from the Mode instance using the [Mode.active_method](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.Mode.active_method) and [Mode.used_method](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.Mode.used_method) ([268](https://github.com/fohrloop/wakepy/pull/268))
- Added possibility to use any dbus python implementation through the [DBusAdapter](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.DBusAdapter). By default uses jeepney through [JeepneyDBusAdapter](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.JeepneyDBusAdapter) (See: [45](https://github.com/fohrloop/wakepy/issues/45))

🚨 Backwards incompatible
- Removed set_keepawake and unset_keepawake functions and the keepawake context manager. These were deprecated in 0.7.0 and are replaced with the new api: [keep.running()](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.keep.running) and [keep.presenting()](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.keep.presenting) context managers. ([85](https://github.com/fohrloop/wakepy/pull/85))
- Renamed the CLI argument -s, --keep-screen-awake to -p, --presentation. The old ones were deprecated in 0.7.0. ([179](https://github.com/fohrloop/wakepy/pull/179/))
- If Mode activation fails, raise [ActivationError](https://wakepy.readthedocs.io/v0.8.0/api-reference.html#wakepy.ActivationError) by default. Previously there was no “on fail” action, but users needed to check the result.success to make sure the activation was successful.
- The org.freedesktop.ScreenSaver based method is not used on keep.running mode. Systems supporting org.freedesktop.ScreenSaver which are not running Gnome will have no keep.running method until it gets implemented. By default wakepy will raise a wakepy.ActivationError if keep.running is used on such system. Either use keep.preseting mode, or wait or provide a PR.
- The [WAKEPY_FAKE_SUCCESS](https://wakepy.readthedocs.io/v0.8.0/tests-and-ci.html#wakepy-fake-success) check is done before trying any wakepy Methods (previously, it was used when all the tried methods have failed)

🐞 Bug fixes
- The org.freedesktop.ScreenSaver based method is only used in keep.presenting mode. Previously, it was used on keep.running mode on Linux. ([46](https://github.com/fohrloop/wakepy/issues/46), [#136](https://github.com/fohrloop/wakepy/issues/136))
- Still going to sleep - running Fedora 36 ([18](https://github.com/fohrloop/wakepy/issues/18))

📖 Documentation
- Rewritten the docs ([193](https://github.com/fohrloop/wakepy/pull/193), [#194](https://github.com/fohrloop/wakepy/pull/194), [#196](https://github.com/fohrloop/wakepy/pull/196), [#197](https://github.com/fohrloop/wakepy/pull/197), [#198](https://github.com/fohrloop/wakepy/pull/198), [#200](https://github.com/fohrloop/wakepy/pull/200), [#244](https://github.com/fohrloop/wakepy/pull/244), [#271](https://github.com/fohrloop/wakepy/pull/271), [#272](https://github.com/fohrloop/wakepy/pull/272), [#285](https://github.com/fohrloop/wakepy/pull/285), [#286](https://github.com/fohrloop/wakepy/pull/286))
- Remove /en/ from the URL and rename latest to stable ([250](https://github.com/fohrloop/wakepy/pull/250))

👷 Maintenance
- Made the CI tests mandatory for every PR (previously manual) ([191](https://github.com/fohrloop/wakepy/pull/191))
- 100% test coverage + use branch coverage instead of line coverage + enforce 100% coverage ([221](https://github.com/fohrloop/wakepy/pull/221), [#222](https://github.com/fohrloop/wakepy/pull/222))
- Run black+isort+ruff also on tests ([224](https://github.com/fohrloop/wakepy/pull/224))
- Run mypy also on tests + fix the new mypy issues ([227](https://github.com/fohrloop/wakepy/pull/227))
- Add tests for Python 3.12 and 3.13. Now test all supported versions of python on linux, and oldest and newest supported versions on MacOS and Windows. ([160](https://github.com/fohrloop/wakepy/pull/160), [#236](https://github.com/fohrloop/wakepy/pull/236), [#273](https://github.com/fohrloop/wakepy/pull/273))
- Pin docs and tests dependencies ([220](https://github.com/fohrloop/wakepy/pull/220))
- Build docs in CI tests to prevent breaking docs ([211](https://github.com/fohrloop/wakepy/pull/211))
- Run tox and pipeline tests against build wheel instead of the source tree ([231](https://github.com/fohrloop/wakepy/pull/231), [#236](https://github.com/fohrloop/wakepy/pull/236))
- Build both, sdist (tar.gz) and wheel (.whl). 0.7.x had just wheels and <=0.6.x just dist. Start using setuptools-scm and switch from flit to setuptools ([235](https://github.com/fohrloop/wakepy/pull/235)).
- Add invoke commands ([223](https://github.com/fohrloop/wakepy/pull/223))
- Add automatic publishing GitHub workflow ([238](https://github.com/fohrloop/wakepy/pull/238))
- Limit docstrings and comments to 79 characters ([207](https://github.com/fohrloop/wakepy/pull/207))
- WakepyFakeSuccess Method ([152](https://github.com/fohrloop/wakepy/pull/152)) instead of using some custom logic with WAKEPY_FAKE_SUCCESS.
- Split package extras: dev, doc, test and check (was: doc, dev) ([213](https://github.com/fohrloop/wakepy/pull/213)) and start using requirements-*.txt instead of misusing extras ([#228](https://github.com/fohrloop/wakepy/pull/228))
- Ruff: Update from 0.0.270 to 0.3.2 ([206](https://github.com/fohrloop/wakepy/pull/206)), use --no-fix in tox ([#208](https://github.com/fohrloop/wakepy/pull/208)), Stricter ruff rules: W291 ([#209](https://github.com/fohrloop/wakepy/pull/209))
- Black: Update from 23.3.0 to 24.2.0 and reformat ([217](https://github.com/fohrloop/wakepy/pull/217))
- Isort: Update from 5.12.0 to 5.13.2 ([218](https://github.com/fohrloop/wakepy/pull/218))
- Mypy: Update from 1.3.0 to 1.9.0 ([219](https://github.com/fohrloop/wakepy/pull/219)), stricter settings; disallow_untyped_defs = true ([#242](https://github.com/fohrloop/wakepy/pull/242)), disallow_any_unimported = true and warn_unused_ignores = true ([#243](https://github.com/fohrloop/wakepy/pull/243))
- Make wakepy statically typed: Add py.typed ([PEP 561](https://peps.python.org/pep-0561/)) to advertize that wakepy is a fully typed package ([#232](https://github.com/fohrloop/wakepy/pull/232)), add mypy checks on 3.7-3.12 ([#265](https://github.com/fohrloop/wakepy/pull/265))
- Other tox improvements ([233](https://github.com/fohrloop/wakepy/pull/233))
- Convert from flat layout to src layout ([234](https://github.com/fohrloop/wakepy/pull/234))
- Cleanup .gitignore ([237](https://github.com/fohrloop/wakepy/pull/237))