https://github.com/lp1dev/pyreaderos

Python Ebook Reader UI with OS interactions.
https://github.com/lp1dev/pyreaderos

Last synced: 4 days ago
JSON representation

Python Ebook Reader UI with OS interactions.

• Host: GitHub
• URL: https://github.com/lp1dev/pyreaderos
• Owner: lp1dev
• Created: 2023-12-20T14:43:21.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-28T21:38:18.000Z (over 2 years ago)
• Last Synced: 2025-03-29T15:41:54.249Z (over 1 year ago)
• Language: Python
• Size: 576 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# PyReaderOS

PyReaderOS (name subject to change) is a Window Manager + Python UI + Packages combo built on top of [Postmarket OS](https://wiki.postmarketos.org/wiki/Kobo_Clara_HD_(kobo-clara)) for the Kobo Clara HD.

![](./doc/logo.jpg)

The goal of this project is to bring a fully usable UI for postmarketOS on e-readers with the regular degree of customization a GNU/Linux distribution offers.

Some features, including suspend and hardware interactions (leds and screens) work thanks to [Air](https://github.com/bjesus/air) by @bjesus and the Postmarket OS wiki.

---

## Install

![Installation Instructions](./doc/install.md)

## Screenshots

![Main interface](./doc/1.png)

![Reader](./doc/2.png)

![Terminal](./doc/3.png)

## What works

- [x] Main UI

- [x] Reading books from vraious files formats in Documents

- [x] Manual suspend with random screensavers in Pictures

- [x] WiFi management in settings

- [x] Backlight management with UI

- [x] Simple file browser

- [x] Web browser

- [x] Keyboard

- [x] Custom apps from .desktop files

## Todo

- [ ] Automatic install script on top of PostmarketOS

- [ ] Backup keyboard configuration 

- [ ] Gallery

- [ ] Refocus (win + n) with a UI button

- [ ] Easier change of font size for books

- [ ] Automatic suspend

- [ ] Enhance LED management

- [ ] Other devices compatilibity

## Attribution

Icons are from [boxicons](https://boxicons.com/) Copyright (c) 2015-2021 Aniket Suvarna (MIT License).

---

## License

MIT License

Copyright (c) 2024 Jeremie Amsellem.

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.