Skip to content

Commit

Permalink
Update readme and changelog for 0.10.0 release (#398)
Browse files Browse the repository at this point in the history
  • Loading branch information
fohrloop authored Sep 20, 2024
1 parent 51d5722 commit 9f48d20
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Wakepy may keep the following systems awake. βŒ›: <a href="https://wakepy.readth
</tbody>
</table>

Unix above refers to Linux in wakepy 0.9.x, but upcoming releases of wakepy will support any Unix-like systems, e.g. FreeBSD ([wakepy/#359](https://github.com/fohrloop/wakepy/issues/)). See also: [Wakepy roadmap](#wakepy-roadmap).
Unix above refers to any Unix-like systems which might use such DEs, e.g. Linux or FreeBSD. See also: [Wakepy roadmap](#wakepy-roadmap).

## Installing

Expand All @@ -80,7 +80,7 @@ Wakepy can also be installed from conda-forge with
```
conda install wakepy
```
For more details and install options, see: [Installing documentation](https://wakepy.readthedocs.io/stable/cli-api.html).
For more details and install options, see: [Installing documentation](https://wakepy.readthedocs.io/stable/installing.html).

<!-- wakepy readme at install before note -->
> [!NOTE]
Expand Down Expand Up @@ -157,11 +157,14 @@ with keep.presenting():

- [aTrain](https://github.com/JuergenFleiss/aTrain) β€” transcription of speech recordings utilizing machine learning models.
- [mpc-autofill](https://github.com/chilli-axe/mpc-autofill) β€” Automating MakePlayingCards' online ordering system
- [LiveboxMonitor](https://github.com/p-dor/LiveboxMonitor) β€” Graphical user interface for routers (French project)
- [FOLON-FO4Downgrader](https://github.com/Fallout-London/FOLON-FO4Downgrader) β€” Tool for reverting to a previous version of a game (Fallout 4)
- [BD_to_AVP](https://github.com/cbusillo/BD_to_AVP) β€” 3D Blu-ray to Apple Vision Pro converter
- [davlee1972/upscale_video](https://github.com/davlee1972/upscale_video) β€” Upscaling video using AI
- [minarca](https://github.com/ikus060/minarca) β€” Cross-platform data backup software
- [OceanOptics/Inlinino](https://github.com/OceanOptics/Inlinino) β€” Data logger for oceanography
- [cogent3/EnsemblLite](https://github.com/cogent3/EnsemblLite) β€” Obtaining dumps of Ensembl MySQL databases
- [lakeshore](https://github.com/lakeshorecryotronics/python-driver) β€” Lake Shore instruments python Driver
- [davlee1972/upscale_video](https://github.com/davlee1972/upscale_video) β€” Upscaling video using AI
- [UCSD-E4E/baboon-tracking](https://github.com/UCSD-E4E/baboon-tracking) β€” In pipelines of a Computer Vision project tracking baboons
- [pysimai](https://github.com/ansys/pysimai) β€” A Python wrapper for Ansys SimAI
- [viskillz-blender](https://www.sciencedirect.com/science/article/pii/S2352711023000249) β€” Generating assets of Mental Cutting Test exercises
Expand Down
19 changes: 12 additions & 7 deletions docs/source/changelog.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
# Changelog

## wakepy 0.10.0
πŸ—“οΈ unreleased
πŸ—“οΈ 2024-09-24

### πŸ† 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 {func}`keep.running <wakepy.keep.running>` and {func}`keep.presenting <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) and [#396](https://github.com/fohrloop/wakepy/pull/396))
- 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/stable/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](#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))

### ✨ Enhancements
- Improve warnings and errors if platform is not supported ([#383](https://github.com/fohrloop/wakepy/pull/383))
- Change default `on_fail` action to be "warn" instead of "error" (in keep.running and keep.presenting modes). ([#388](https://github.com/fohrloop/wakepy/pull/388))

### πŸ‘· 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)
- 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))

## wakepy 0.9.1
πŸ—“οΈ 2024-06-04
Expand Down

0 comments on commit 9f48d20

Please sign in to comment.