Portable Wisdom

Portable Wisdom is a command-line tool to generate an EPUB file from your unread articles in Instapaper. You can then copy this file to your ereader.

Technologies

Python 3

Features

Retrieves unread articles from Instapaper
Finds and downloads articles' images from the web, downsizes them, converts them to greyscale, and embeds them into the file
Caches articles and images, runs fast for frequent users
Creates well-formatted EPUB files tailored for your ereader

Quick Start

Before you begin, you'll need to request an Instapaper API key or copy one from a friend.

Python

Download and install Portable Wisdom from PyPI:
```
 $ pip install portable-wisdom
```

Run Portable Wisdom from the command line:

 $ portable-wisdom \
 	--instapaper-api-key KEY \
 	--instapaper-api-secret SECRET \
 	--instapaper-login USER \
 	--instapaper-password PASS

On success, the script will print the output filename. To view all of the options, run $ portable-wisdom -h.

Docker

Alternatively, using Docker, to download and execute Portable Wisdom from Docker Hub, run:

$ docker pull jacobbudin/portable-wisdom:latest
$ docker run jacobbudin/portable-wisdom:latest \
	--instapaper-api-key KEY \
	--instapaper-api-secret SECRET \
	--instapaper-login USER \
	--instapaper-password PASS

Environment

Alternatively, you can supply the Instapaper credentials via environment variables: INSTAPAPER_API_KEY, INSTAPAPER_API_SECRET, INSTAPAPER_LOGIN, and INSTAPAPER_PASSWORD.

Transformers

Transformers are functions that modify the EPUB before writing the file to disk. There are many built-in transformers including:

beautify_hr — converts lines of asterisks to horizontal rules
remove_duplicative_blockquotes — removes magazine-style "pull quotes"
strip_emojis — replaces emojis with shortcodes
strip_links — removes a elements
embed_images — embeds remote web images

Compatibility

Portable Wisdom uses EbookLib to create EPUB files. These files are compatible with most ereaders—including Nook, Kobo, and Sony—as well as most ebook software. Kindle owners can use Pandoc or a similar tool to convert from EPUB to MOBI.

Styles

Portable Wisdom supports styles (--style) to create EPUB files optimized for your ereader's rendering engine. These styles are regular CSS files. They specify header sizes, image layout, quote formatting, etc. Use the default style or create your own.

Contributing

To report a bug or request a feaure, create an issue on GitHub. Developers are welcome and encouraged to submit pull requests, but contributors should strongly consider creating an issue and requesting comments before starting work.

Source

You can run Portable Wisdom from its source like so:

$ python3 -m portable_wisdom.wisdom

Guidelines

Comply with PEP 8 (use Flake8 to confirm, autopep8 can help)
Run and pass all tests
- Create new tests or refine existing ones, if necessary

License

MIT License