Skip to content

Commit 9f48d20

Browse files
authored
Update readme and changelog for 0.10.0 release (#398)
1 parent 51d5722 commit 9f48d20

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Wakepy may keep the following systems awake. ⌛: <a href="https://wakepy.readth
6666
</tbody>
6767
</table>
6868

69-
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).
69+
Unix above refers to any Unix-like systems which might use such DEs, e.g. Linux or FreeBSD. See also: [Wakepy roadmap](#wakepy-roadmap).
7070

7171
## Installing
7272

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

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

158158
- [aTrain](https://github.com/JuergenFleiss/aTrain) — transcription of speech recordings utilizing machine learning models.
159159
- [mpc-autofill](https://github.com/chilli-axe/mpc-autofill) — Automating MakePlayingCards' online ordering system
160+
- [LiveboxMonitor](https://github.com/p-dor/LiveboxMonitor) — Graphical user interface for routers (French project)
161+
- [FOLON-FO4Downgrader](https://github.com/Fallout-London/FOLON-FO4Downgrader) — Tool for reverting to a previous version of a game (Fallout 4)
162+
- [BD_to_AVP](https://github.com/cbusillo/BD_to_AVP) — 3D Blu-ray to Apple Vision Pro converter
163+
- [davlee1972/upscale_video](https://github.com/davlee1972/upscale_video) — Upscaling video using AI
160164
- [minarca](https://github.com/ikus060/minarca) — Cross-platform data backup software
161165
- [OceanOptics/Inlinino](https://github.com/OceanOptics/Inlinino) — Data logger for oceanography
162166
- [cogent3/EnsemblLite](https://github.com/cogent3/EnsemblLite) — Obtaining dumps of Ensembl MySQL databases
163167
- [lakeshore](https://github.com/lakeshorecryotronics/python-driver) — Lake Shore instruments python Driver
164-
- [davlee1972/upscale_video](https://github.com/davlee1972/upscale_video) — Upscaling video using AI
165168
- [UCSD-E4E/baboon-tracking](https://github.com/UCSD-E4E/baboon-tracking) — In pipelines of a Computer Vision project tracking baboons
166169
- [pysimai](https://github.com/ansys/pysimai) — A Python wrapper for Ansys SimAI
167170
- [viskillz-blender](https://www.sciencedirect.com/science/article/pii/S2352711023000249) — Generating assets of Mental Cutting Test exercises

docs/source/changelog.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,31 @@
11
# Changelog
22

33
## wakepy 0.10.0
4-
🗓️ unreleased
4+
🗓️ 2024-09-24
5+
6+
### 🏆 Highlights
7+
- Wakepy has been available in conda-forge since 0.9.1. Now it's also documented.
8+
- Warn instead of raise Exception by default if activating a Mode fails.
9+
510

611
### ✨ Features
12+
- 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))
713
- 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))
8-
- Add support for PyPy ([#393](https://github.com/fohrloop/wakepy/pull/393) and [#396](https://github.com/fohrloop/wakepy/pull/396))
14+
- Add support for PyPy ([#393](https://github.com/fohrloop/wakepy/pull/393), [#396](https://github.com/fohrloop/wakepy/pull/396))
915
- 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))
1016
- 🚨 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))
1117
- 🚨 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))
12-
13-
### ✨ Enhancements
1418
- Improve warnings and errors if platform is not supported ([#383](https://github.com/fohrloop/wakepy/pull/383))
15-
- 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))
1619

1720
### 👷 Maintenance
1821
- 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))
19-
- Fixed: Tests failing on Fedora 40 [#381](https://github.com/fohrloop/wakepy/pull/381)
20-
- Update various development time dependencies [#389](https://github.com/fohrloop/wakepy/pull/389)
22+
- Fixed: Tests failing on Fedora 40 ([#381](https://github.com/fohrloop/wakepy/pull/381))
23+
- Update various development time dependencies ([#389](https://github.com/fohrloop/wakepy/pull/389))
2124

2225
### 📖 Documentation
2326
- 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))
27+
- Add Roadmap and improve the Supported Platforms docs ([#365](https://github.com/fohrloop/wakepy/pull/365))
28+
- Add logos and banners ([#370](https://github.com/fohrloop/wakepy/pull/370), [#371](https://github.com/fohrloop/wakepy/pull/371))
2429

2530
## wakepy 0.9.1
2631
🗓️ 2024-06-04

0 commit comments

Comments
 (0)