Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fgebhart/zeit-on-tolino
Service to auto-upload the ZEIT 🗞 e-paper to your tolino cloud library 📚
https://github.com/fgebhart/zeit-on-tolino
ebook ebook-reader epub github-actions python selenium tolino
Last synced: about 2 months ago
JSON representation
Service to auto-upload the ZEIT 🗞 e-paper to your tolino cloud library 📚
- Host: GitHub
- URL: https://github.com/fgebhart/zeit-on-tolino
- Owner: fgebhart
- License: mit
- Created: 2022-07-24T06:40:14.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-06T01:40:33.000Z (6 months ago)
- Last Synced: 2024-10-12T16:46:35.961Z (2 months ago)
- Topics: ebook, ebook-reader, epub, github-actions, python, selenium, tolino
- Language: Python
- Homepage:
- Size: 3.16 MB
- Stars: 14
- Watchers: 1
- Forks: 24
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# zeit-on-tolino
Service to auto-upload the ZEIT 🗞 e-paper to your Tolino cloud library 📚
⚠️ As I switched to a different e-reader, zeit-on-tolino is no longer actively maintained. Use it with caution and feel free to fork. ⚠️
## Why yet another zeit-on-tolino service?
I know there are a bunch of similar repos out there, but as far as I know, they all depend on some additional resources
which take care of triggering and executing the syncing mechanism. `zeit-on-tolino` solves this by using GitHub actions.
This service uses a scheduled GitHub actions workflow for automating the down- and upload of the e-paper, so you don't
have to worry about the runtime environment of the scripts. See usage instructions below for more details
## Usage
1. [Fork this repo](https://github.com/fgebhart/zeit-on-tolino/fork) to your own GitHub space
2. Go to your repo's settings and navigate to Actions > General > Actions permissions and enable
"Allow all actions and reusable workflows".
3. Now navigate to the Secrets page: Settings > Security > Secrets > Actions.
4. Add the following secrets by clicking on the "New repository secret" button:
1. `TOLINO_PARTNER_SHOP`: The name of the shop you purchased your device from (see [supported shops](https://github.com/fgebhart/zeit-on-tolino#which-tolino-partner-shops-are-supported)).
1. `TOLINO_USER`: The username (usually an email address) you use for logging into the Tolino cloud.
2. `TOLINO_PASSWORD`: The associated password.
3. `ZEIT_PREMIUM_USER`: Your ZEIT premium username.
4. `ZEIT_PREMIUM_PASSWORD`: The associated password.
1. Observe that your forked repo automatically triggers the sync,
[given the configuration of the scheduled trigger](https://github.com/fgebhart/zeit-on-tolino/blob/main/.github/workflows/sync_to_tolino_cloud.yml#L5-L7).
For a more detailed step-by-step guide check out [my blog post about `zeit-on-tolino`](https://blog.fgebhart.dev/2022/auto-sync-zeit-epub-to-your-tolino/).
## FAQ
### Which Tolino Partner Shops are supported?
Currently, not all Tolino partner shops are supported. The following shops are supported and should work out of the box:
* `thalia`
* `hugendubel`
Make sure to set the `TOLINO_PARTNER_SHOP` environment variable to one of the supported values. In case the shop
you want to use is missing, feel free to either [open an issue](https://github.com/fgebhart/zeit-on-tolino/issues/new) or
raise a PR that adds the additional shop.
In case you want to add a new partner shop to the list of supported shops, I recommend checking the [tolino_partner.py](https://github.com/fgebhart/zeit-on-tolino/blob/main/zeit_on_tolino/tolino_partner.py) file. This file contains the minimal required configuration
values needed for a successful login. It specifies how selenium should find the user and password fields and also the
string `shop_image_keyword`, which needs to be part of the style attribute of the image `
` of your shop to be
clicked on. If that does not make too much sense to you, don't worry - feel free to reach out and I will be happy to
provide support 🙂
### Is it possible to manually sync the Zeit E-Paper to my Tolino Cloud?
Yes, to manually sync the latest ZEIT e-paper to your Tolino cloud, follow these steps:
1. Clone the repo to your local machine via `git clone [email protected]:fgebhart/zeit-on-tolino.git` and `cd zeit-on-tolino`
2. Install the requirements via `pip install poetry` and `poetry install`
3. Export the above-mentioned environment variables to your local environment
4. Run the python sync script via `python sync.py`
This script can of course also be executed in a cron-scheduled fashion on a raspberry by or similar.
### How can I update your forked repo?
To benefit from recent changes in the [upstream zeit-on-tolino repo](https://github.com/fgebhart/zeit-on-tolino) use the
`Update Fork` GitHub actions workflow. Navigate to your GitHub actions and dispatch the workflow by manually clicking via
the GitHub UI.
### The Sync Github Actions Workflow is not triggered in my forked Repo?
After forking the repo you need to enable running workflows for your repo. Go to your repo's settings and navigate to
Actions > General > Actions permissions and enable "Allow all actions and reusable workflows".
## Contributing
All kinds of contributions are welcome!
### Setup Dev Environment
Clone the repo:
```bash
git clone [email protected]:fgebhart/zeit-on-tolino.git && cd zeit-on-tolino
```
and install the requirements using poetry:
```bash
poetry install
```
### Running the tests
Note, running the tests requires exporting the above-mentioned environment variables because the tests simulate the
upload flow of a dummy epub file to your Tolino cloud. Be aware of this side-effect, though, the dummy file will be
removed from your Tolino cloud once the upload was successful.
Run the tests via:
```bash
pytest tests
```