diff --git a/CHANGELOG.md b/CHANGELOG.md index a7104b9..e2dc37f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,16 +4,19 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) -## Version Unreleased +## Version 0.4.0 ### Added - support for Raspberry Pi OS 12 (Bookworm) and Python 3.11 through some dependency fixes +- information regarding Python virtual environment usage +- disclaimer on status of official Waveshare repo support with Bookworm ### Changed - updated IT8951 repo link to build from source with RPI dependencies - Waveshare drivers now loaded from [forked repo](https://github.com/mendhak/waveshare-epaper-sample) to fix Bookworm Rpi detection +- `setup.cfg` information merged into `pyproject.toml` ## Version 0.3.5 diff --git a/README.md b/README.md index 9544532..c1855ef 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ An EPD (electronic paper display) class abstraction to simplify communications across multiple display types. -There are several great EPD projects all over the internet, many in written in Python. The problem with a lot of these is that the code is often for one specific type of display, or perhaps a family of displays. This project abstracts the EPD communications into a common interface so a variety of displays can be interchangeably used in the same project. It also adds a lot of [helpful conveniences](#advanced-epd-control) such as the ability to automatically to rotate, add contrast, or dither images on their way to the display. This gives more control to end users without having to add extra features in your upstream project. +There are several great EPD projects all over the internet, many in written in Python. The problem with a lot of these is that the code is often for one specific type of display, or perhaps a family of displays. This project abstracts the EPD communications into a common interface so a variety of displays can be interchangeably used in the same project. It also adds a lot of [helpful conveniences](#advanced-epd-control) such as the ability to automatically rotate, add contrast, or dither images on their way to the display. This gives more control to end users without having to add extra features in your upstream project. For EPD project builders this expands the number of displays you can use for your project without having to code around each one. To utilize this in your project read the usage instructions. For a list of (known) projects that use this abstraction see the [list below](#displays-implmented). @@ -206,7 +206,9 @@ If installing Inky manually be sure that SPI and I2C are enabled via `sudo raspi __Waveshare__ -The [Waveshare device library](https://github.com/waveshareteam/e-Paper) requires that [SPI support](https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/) be enabled on your system prior to use. The `waveshare-epd` module is automatically downloaded and installed as a dependency of this module. +The [Waveshare device library](https://github.com/waveshareteam/e-Paper) requires that [SPI support](https://www.raspberrypi-spy.co.uk/2014/08/enabling-the-spi-interface-on-the-raspberry-pi/) be enabled on your system prior to use. The `waveshare-epd` module is automatically downloaded and installed as a dependency of this module. + +__Please note:__ The version of the Waveshare repo used by this library is a [fork](https://github.com/mendhak/waveshare-epaper-sample) of the official repository. This is due to the official repo not having [correct detection support](https://github.com/waveshareteam/e-Paper/pull/307/) for Raspberry Pi OS 12 (Bookworm). Once the official repo is updated the source for the Waveshare drivers will be moved back to the official repo. __IT8951__ diff --git a/pyproject.toml b/pyproject.toml index 09eab80..a5528ba 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,7 +8,7 @@ build-backend = "setuptools.build_meta" [project] name = "omni_epd" -version = "0.3.6b1" +version = "0.4.0" requires-python = ">=3.7" authors = [ {name = "Rob Weber", email = "robweberjr@gmail.com"}