A fetcher hook for the Plato document reader that syncs an e-reader with an OPDS catalogue.

Last update: Nov 8, 2023

Related tags

Utilities plato-opds

Overview

plato-opds

A fetcher hook for the Plato document reader that syncs an e-reader with an OPDS catalogue.

Motivation

I wanted to be able to sync my e-reader with my calibre-web library so that any new books/documents I add are downloaded automatically.

This project makes no guarantees to be OPDS spec-compliant and your milage may vary.

Pre-built binaries can be found on the releases page.

Usage

Download/build a opds_fetcher binary and create a folder in Plato's bin directory for it (usually /mnt/onboard/.adds/plato/bin/opds)
Rename Settings-sample.toml to Settings.toml and place it alongside the binary. Configure your servers and tweak settings how you like.
Add a hook to Plato's own Settings.toml that looks like the following:

[[libraries.hooks]]
path = "OPDS"
program = "bin/opds/opds_fetcher"
sort-method = "added"
first-column = "title-and-author"
second-column = "progress"

Whenever the OPDS folder is opened, this hook will check if there are any books that haven't been downloaded and will fetch them if need be.

Building

The easiest way to build this project is to use cross to cross-compile with Docker. Once setup it's as simple as running:

cross build --release --target=arm-unknown-linux-gnueabihf

Building without Docker

After setting up the Linaro toolchain on your system you can compile the project with:

rustup target add arm-unknown-linux-gnueabihf
cargo build --release --target=arm-unknown-linux-gnueabihf

Acknowledgements

This hook is based on the work done for the built-in Plato article fetcher. The license of which is included below.

Plato -- Document reader for the Kobo e-ink devices.
Copyright (C) 2017 Bastien Dejean.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

Single-reader, multi-writer & single-reader, multi-verifier; broadcasts reads to multiple writeable destinations in parallel

Bus Writer This Rust crate provides a generic single-reader, multi-writer, with support for callbacks for monitoring progress. It also provides a gene

26 Feb 7, 2022

Basic system information fetcher, with a focus on performance.

Table of Contents: About Changelog Dependencies Benchmarks Features Installation Platform Support About Macchina Macchina lets you view basic system i

677 Dec 28, 2022

EMOte FEtcher. Download an entire channel's emotes from TwitchEmotes.com.

Emofe EMOte FEtcher. Download an entire channel's emotes from TwitchEmotes.com. Disclaimer This is just an excuse to learn Rust. Nobody in their right

3 Nov 17, 2022

Generate Nix fetcher calls from repository URLs [maintainer=@figsoda]

nurl Generate Nix fetcher calls from repository URLs $ nurl https://github.com/nix-community/patsh v0.2.0 2/dev/null fetchFromGitHub { owner = "nix

103 Jan 29, 2023

⚡🦀 Yet another rust system info fetcher.

Yarsi: Yet another rust sys info fetcher ✨ Showcase requirements 🙀 cargo 🦀 install with $ curl https://sh.rustup.rs -sSf | sh installation ❤️‍🩹 Ya

8 Jan 26, 2023

miette is a diagnostic library for Rust. It includes a series of traits/protocols that allow you to hook into its error reporting facilities, and even write your own error reports!

1.2k Jan 1, 2023

A git hook to manage derivative files automatically.

git-derivative A git hook to manage derivative files automatically. For example if you checked out to a branch with different yarn.lock, git-derivativ

3 Oct 30, 2022

A panic hook for wasm32-unknown-unknown that logs panics with console.error

console_error_panic_hook This crate lets you debug panics on wasm32-unknown-unknown by providing a panic hook that forwards panic messages to console.

241 Jan 3, 2023

Scouty is a command-line interface (CLI) to keep an eye on substrate-based chains and hook things up

scouty is a command-line interface (CLI) to keep an eye on substrate-based chains and hook things up

15 Aug 6, 2022

A git prepare-commit-msg hook for authoring commit messages with GPT-3.

gptcommit A git prepare-commit-msg hook for authoring commit messages with GPT-3. With this tool, you can easily generate clear, comprehensive and des

3 Jan 19, 2023

Pre-commit hook to help me stop naming files *.yml half of the time

Disallow file endings Pre-commit hook that lets you specify banned file endings. I keep naming half my yaml files *.yaml and the other *.yml and it's

4 Mar 8, 2023

⚙️ Pre-commit hook for downgrading Python logger syntax

printf-log-formatter Automatically convert f-strings and str.format() syntax to printf-style strings. In other words, this syntax logger.error(f"{1}")

5 Apr 25, 2023

A Rust library for PDF document manipulation.

lopdf A Rust library for PDF document manipulation. Example Code Create PDF document #[macro_use] extern crate lopdf; use lopdf::{Document, Object, St

1.1k Dec 30, 2022

Perlin: An Efficient and Ergonomic Document Search-Engine

Table of Contents 1. Perlin Perlin Perlin is a free and open-source document search engine library build on top of perlin-core. Since the first releas

70 Dec 9, 2022

A html document syntax and operation library written in Rust, use APIs similar to jQuery.

Visdom A server-side html document syntax and operation library written in Rust, it uses apis similar to jQuery, left off the parts thoes only worked

80 Dec 21, 2022

A programmable document database inspired by CouchDB written in Rust

PliantDB PliantDB aims to be a Rust-written, ACID-compliant, document-database inspired by CouchDB. While it is inspired by CouchDB, this project will

718 Dec 31, 2022

RefineDB - A strongly-typed document database that runs on any transactional key-value store.

375 Jan 4, 2023

docx-you-want is a tool to convert a PDF document into a .docx file

ddocx-you-want is a tool to convert a PDF document into a .docx file ... in an unusual way. Since these two formats are inherently differ

45 Dec 23, 2022

Generate an HTML page based on a Notion document

Notion Generator Generate an HTML page based on a Notion document! Still a bit of a work in progress, but I am about to actually use it for some actua

9 Dec 14, 2022

Comments

binaries or build instructions?

I would really like to try your hook, is it possible you provide the binaries too? I can't get the toolchain + rust combination to work on my macos machine.

a docker build image would be fine too

opened by RMHogervorst 2

A fetcher hook for the Plato document reader that syncs an e-reader with an OPDS catalogue.

Related tags

Overview

plato-opds

Motivation

Usage

Building

Building without Docker

Acknowledgements

You might also like...

Single-reader, multi-writer & single-reader, multi-verifier; broadcasts reads to multiple writeable destinations in parallel

Basic system information fetcher, with a focus on performance.

EMOte FEtcher. Download an entire channel's emotes from TwitchEmotes.com.

Generate Nix fetcher calls from repository URLs [maintainer=@figsoda]

⚡🦀 Yet another rust system info fetcher.

miette is a diagnostic library for Rust. It includes a series of traits/protocols that allow you to hook into its error reporting facilities, and even write your own error reports!

A git hook to manage derivative files automatically.

A panic hook for wasm32-unknown-unknown that logs panics with console.error

Scouty is a command-line interface (CLI) to keep an eye on substrate-based chains and hook things up

A git prepare-commit-msg hook for authoring commit messages with GPT-3.

Pre-commit hook to help me stop naming files *.yml half of the time

⚙️ Pre-commit hook for downgrading Python logger syntax

A Rust library for PDF document manipulation.

Perlin: An Efficient and Ergonomic Document Search-Engine

A html document syntax and operation library written in Rust, use APIs similar to jQuery.

A programmable document database inspired by CouchDB written in Rust

RefineDB - A strongly-typed document database that runs on any transactional key-value store.

docx-you-want is a tool to convert a PDF document into a .docx file

Generate an HTML page based on a Notion document

Comments

binaries or build instructions?

Releases(v1.0.0)

v1.0.0(Oct 22, 2023)

Owner

miette is a diagnostic library for Rust. It includes a series of traits/protocols that allow you to hook into its error reporting facilities, and even write your own error reports!

A git hook to manage derivative files automatically.

A git prepare-commit-msg hook for authoring commit messages with GPT-3.

Generate an HTML page based on a Notion document

A shared document application akin to Google Docs. Example usage of wasm-peers library.

Stack buffer provides alternatives to Buf{Reader,Writer} allocated on the stack instead of the heap.

Arduino Uno 9 axis acceleration sensor (BMX055) reader implemented in Rust.

Easy c̵̰͠r̵̛̠ö̴̪s̶̩̒s̵̭̀-t̶̲͝h̶̯̚r̵̺͐e̷̖̽ḁ̴̍d̶̖̔ ȓ̵͙ė̶͎ḟ̴͙e̸̖͛r̶̖͗ë̶̱́ṉ̵̒ĉ̷̥e̷͚̍ s̷̹͌h̷̲̉a̵̭͋r̷̫̊ḭ̵̊n̷̬͂g̵̦̃ f̶̻̊ơ̵̜ṟ̸̈́ R̵̞̋ù̵̺s̷̖̅ţ̸͗!̸̼͋

A document-code sync tools for document engineering.

A catalogue of Rust design patterns, anti-patterns and idioms