Skip to content

Commit 8009c9a

Browse files
committed
Update CHANGELOG
1 parent bee6063 commit 8009c9a

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

CHANGELOG.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,24 @@
1+
## 2025/04/08 Release 5.0.0
12
- API Changes:
23
- **NEW:** `Receiver` class
34
- A subclass of `asyncio.Queue`
45
- `Client`:
5-
- `subscribe` and `unsubscribe` methods use new `Receiver` class
6+
- **BREAKING:** `subscribe` and `unsubscribe` methods use new `Receiver` class
67
- Emit unmatched exceptions on expecting receivers instead of resolving `client.closed`
78
- `detect_baud_rate` exposes `timeout` and `retry_times` arguments
89
- Document `detect_baud_rate`
9-
- **Breaking:** `ClientProtocol`/`EffectClient`
10+
- **BREAKING:** `ClientProtocol`/`EffectClient`
1011
- `crystalfontz.protocol.ClientProtocol` type has been replaced by `crystalfontz.effects.EffectClient`
1112
- `EffectClient` enforces a smaller API than `ClientProtocol` did previously
12-
- `Response`:
13+
- **BREAKING:** `Response`:
1314
- `Response.from_bytes` accepts bytes as from packets, rather than `__init__`
1415
- `Response.__init__` accepts properties as arguments
15-
- `SpecialCharacter` API:
16+
- **BREAKING:** `SpecialCharacter` API:
1617
- Rename `as_bytes` method to `to_bytes`
1718
- Store pixels as `List[List[bool]]` instead of `List[List[int]]`
1819
- `KeyState` includes `keypress: KeyPress` attribute
1920
- CLI changes:
20-
- **Breaking:** CLI now invoked through `python3 -m crystalfontz`
21+
- **BREAKING:** CLI now invoked through `python3 -m crystalfontz`
2122
- Optional unpackaged `crystalfontz` entry point at `./bin/crystalfontz`
2223
- Use `configurence` library
2324
- Respect `CRYSTALFONTZ_CONFIG_FILE` environment variable
@@ -29,11 +30,6 @@
2930
- `python3 -m crystalfontz line 2`
3031
- `python3 -m crystalfontz send`
3132
- Help for `python3 -m crystalfontz listen` `--for` option
32-
- Integration tests:
33-
- Use `python-gak` plugin
34-
- Use snapshots
35-
- Leverage a config file at `./tests/fixtures/crystalfontz.yaml`
36-
- Can be overridden with `CRYSTALFONTZ_CONFIG_FILE` environment variable
3733
- **NEW:** Dbus support:
3834
- `crystalfontz.dbus.DbusInterface` dbus Interface class, implementing most commands
3935
- `crystalfontz.dbus.DbusClient` dbus client class
@@ -42,6 +38,20 @@
4238
- Optional unpackaged `crystalfontz.dbus.service` entry point at `./bin/crystalfontz-service`
4339
- `python3 -m crystalfontz.dbus.client` dbus client CLI
4440
- Optional unpackaged `crystalfontz.dbus.client` entry point at `./bin/crystalfontz-dbus`
41+
- Packaging and Releases:
42+
- `python-crystalfontz` COPR package spec
43+
- This has been moved from <https://github.com/jfhbrook/public>
44+
- **NEW:** `crystalfontz` COPR package
45+
- Depends on `python-crystalfontz` COPR package
46+
- Includes systemd unit for `python3 -m crystalfontz.dbus.service`
47+
- **BREAKING:** Includes shim bin `crystalfontz` -> `python3 -m crystalfontz.dbus.client`
48+
- Tito based release tagging
49+
- GitHub release tarball
50+
- Integration tests:
51+
- Use `python-gak` plugin
52+
- Use snapshots
53+
- Leverage a config file at `./tests/fixtures/crystalfontz.yaml`
54+
- Can be overridden with `CRYSTALFONTZ_CONFIG_FILE` environment variable
4555

4656
## 2025/01/12 Version 4.0.0
4757
- Fedora package on COPR: <https://copr.fedorainfracloud.org/coprs/jfhbrook/joshiverse/package/python-crystalfontz/>

0 commit comments

Comments
 (0)