iicd/Inkycal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

prepare for release 2.0.4

Browse Source
This commit is contained in:
Ace 2024-06-26 01:47:58 +02:00
parent f0313066da
commit 758d748d76
9 changed files with 66 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.github/workflows/test-on-rpi.yml vendored
View File

@ -42,7 +42,7 @@ jobs:
whoami
cd /home/inky
sudo apt-get update -y
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python3-dev scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-dev -y
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python3-dev scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-base libopenblas-dev -y
echo $PWD && ls
git clone https://github.com/aceinnolab/Inkycal
cd Inkycal

2
.github/workflows/update-os.yml vendored
View File

@ -40,7 +40,7 @@ jobs:
# sudo apt-get dist-upgrade -y
sudo apt-get install -y python3-pip
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python3-dev scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-dev libxml2-dev libxslt-dev python-dev-is-python3 -y
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python3-dev scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-base libopenblas-dev libxml2-dev libxslt-dev python-dev-is-python3 -y
# #334 & #335
git clone https://github.com/WiringPi/WiringPi
cd WiringPi

42
Changelog.md
View File

@ -1,13 +1,47 @@
# E-Paper-Calendar Software Changelog
# Inkycal Software Changelog
All significant changes will be documented in this file.
The order is from latest to oldest and structured in the following way:
* Version name with date of publishing
* Sections with either 'added', 'fixed', 'updated' and 'changed'
* Sections with either 'added', 'fixed', 'updated', 'changed' or 'removed' to describe the changes
## [2.0.3] 2024
### Changed
- Updated dependencies to the most-recent supported version
- Unified logging all over the library. Print statements are now rare. This makes it easier to identify why Inkycal isn't working without having to look up the logs
- Inkycal now makes use of a JSON-Cache to make it more resilient against resets etc. For example, the slideshow module will remember the last index even after a shutdown
- Inkycal now uses a list of supported displays instead of having to look up each driver in the driver directory
- Renamed tests according to python standards, starting with `test_..`, allowing unittest/pytest to automatically discover and run these tests.
### Fixed
- Fixed an annoying vertical alignment issue causing some characters to look chopped off
- Fixed the alignment of the red-circle on the calendar module
- Fixed weekday-names not translating in the weather module
- Fixed python 3.11 issues with numpy on Raspberry Pi OS
### Added
* Added fullscreen weather module
* Own OWM API abstraction as a replacement for PyOWM module
- Added long-awaited support of PiSugar v1/2/3. Still a bit experimental (no calibration handling), but works for most part. If PiSugar support is enabled, Inkycal will set the new alarm before shutting down the system, increasing battery life. Please note that around 70 updates were possible with the 1200mAh PiSugar 3 board, so one update a day to three should be max to get at least one month battery life.
- Added Webshot module which can be used to display a webpage. Works on InkycalOS-Lite too and does not need a GUI.
- Added XKCD module
- Added Tindie module
- Added support for much longer update-intervals than the previous max of once every 60 minutes
- Added Material-UI icons font
- Added dedicated Pipeline for unittests directly on Raspberry Pi OS to ensure Inkycal can run reliably on Raspberry Pi OS
- Added Feature-request and PR template
- Added support for 5.83" display (v2)
- Added support for 12.48" display on 64-bit systems
- Added Inkycal fullweather-module
- Added `settings.py file (not to be confused with `settings.json`) to set VCOM and other internal variables
## [2.0.3] 2023
### Changed
- Switched from pyowm to custom wrapper as pyowm only works up to python3.9, which is now outdated.
- Updated dependencies to the most-recent supported version
### Fixed
- Fixed python 3.11 issues with numpy on Raspberry Pi OS
- Fixed compatibility issues with Pillow when switching from v9.x to v10.x, particularly font width and height operations
- Renamed tests according to python standards, starting with `test_..`, allowing unittest/pytest to automatically discover and run these tests.
## [2.0.2] 2022

2
README.md
View File

@ -169,7 +169,7 @@ Run the following steps to install Inkycal. Do **not** use sudo for this, except
```bash
# Raspberry Pi specific section start
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python-dev-is-python3 scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-dev
sudo apt-get install git zlib1g libjpeg-dev libatlas-base-dev rustc libopenjp2-7 python-dev-is-python3 scons libssl-dev python3-venv python3-pip git libfreetype6-dev wkhtmltopdf libopenblas-base libopenblas-dev
git clone https://github.com/WiringPi/WiringPi
cd WiringPi
./build

2
docsource/conf.py
View File

@ -22,7 +22,7 @@ copyright = '2018-2023, aceinnolab'
author = 'aceinnolab'
# The full version, including alpha/beta/rc tags
release = '2.0.3'
release = '2.0.4'
# -- General configuration ---------------------------------------------------

37
inky_run.py
View File

@ -8,24 +8,8 @@ import asyncio
from inkycal import Inkycal
async def dry_run():
# create an instance of Inkycal
# If your settings.json file is not in /boot, use the full path:
# inky = Inkycal('path/to/settings.json', render=True)
inky = Inkycal(render=False)
await inky.run(run_once=True) # dry-run without rendering anything on the display
async def clear_display():
print("loading Inkycal and display driver...")
inky = Inkycal(render=True) # Initialise Inkycal
print("clearing display...")
inky.calibrate(cycles=1) # Calibrate the display
print("clear complete...")
print("finished!")
async def run():
"""Run Inkycal nonstop. Default mode."""
# create an instance of Inkycal
# If your settings.json file is not in /boot, use the full path:
# inky = Inkycal('path/to/settings.json', render=True)
@ -36,5 +20,24 @@ async def run():
await inky.run() # If there were no issues, you can run Inkycal nonstop
async def dry_run():
"""Useful for checking if the settings.json file is okay, without actually touching the display"""
# create an instance of Inkycal
# If your settings.json file is not in /boot, use the full path:
# inky = Inkycal('path/to/settings.json', render=True)
inky = Inkycal(render=False)
await inky.run(run_once=True) # dry-run without rendering anything on the display
async def clear_display():
"""Calibrate the display if you see some ghosting"""
print("loading Inkycal and display driver...")
inky = Inkycal(render=True) # Initialise Inkycal
print("clearing display...")
inky.calibrate(cycles=1) # Calibrate the display
print("clear complete...")
print("finished!")
if __name__ == "__main__":
asyncio.run(run())

2
inkycal/display/display.py
View File

@ -1,6 +1,6 @@
"""
Inkycal ePaper driving functions
Copyright by aceisace
Copyright by aceinnolab
"""
from importlib import import_module

2
inkycal/main.py
View File

@ -39,7 +39,7 @@ class Inkycal:
def __init__(self, settings_path: str or None = None, render: bool = True, use_pi_sugar: bool = False):
"""Initialise Inkycal"""
self._release = "2.0.3"
self._release = "2.0.4"
logger.info(f"Inkycal v{self._release} booting up...")

4
setup.py
View File

@ -13,10 +13,10 @@ with open('requirements.txt') as f:
required = [i.split(' ')[0] for i in required]
__project__ = "inkycal"
__version__ = "2.0.3"
__version__ = "2.0.4"
__description__ = "Inkycal is a python3 software for syncing icalendar events, weather and news on selected E-Paper displays"
__packages__ = ["inkycal"]
__author__ = "aceisace"
__author__ = "aceinnolab"
__author_email__ = "aceisace63@yahoo.com"
__url__ = "https://github.com/aceinnolab/Inkycal"