calibre store for The Eye

The Eye store plugin for calibre

Installation

Download the latest ZIP from the “Releases” page and follow these steps to add the plugin to calibre:

1. Open calibre
2. Open Preferences (⌘+,)
3. Open Plugins, bottom left
4. Click “Load plugin from file”, bottom right
5. Point the dialog to the downloaded ZIP file
6. Click “Apply”
7. Quit and restart calibre

Alternatively, run this in your terminal, pointing to the downloaded ZIP file:

calibre-customize -a "The Eye vX.X.X.zip"

Where X.X.X is the release you’ve downloaded.

Setup

• Note that this plugin searches a local index of The Eye. Before being able to search, you’ll have to click the “Update Index” button in the plugin's preferences (“Preferences” > “Plugins” > select “The Eye” > “Customize plugin”) to create or update that local index.
• In those plugin preferences you'll also find options to restrict results to a specific file format (e.g. “epub, mobi”).

Searching

• Because the index really is just a long list of URLs, there is no difference between “Title”, “Author” or “Keyword” when searching. I arbitrarily chose the first one, which means you can type anything you’re looking for in the “Title” field and ignore the other two.
• Note that searching is case-insensitive.

Testing & development

While working on any of the scripts, run this from within this repository to shutdown calibre, update the plugin and restart in debug mode:

calibre-debug -s && calibre-customize -b . && calibre-debug -g

Or, when you're one step further, install the plugin as a user would and restart in debug mode:

calibre-debug -s && make && calibre-customize -a "releases/The Eye vX.X.X.zip" && calibre-debug -g

Where X.X.X is the release you’re testing.

Build a release

make

Changelog

All notable changes to this project will be documented here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

0.2.3-alpha: 2020-11-28

Changed

• Only update index when forced

0.2.2-alpha: 2020-11-26

Changed

• Added line breaks in the index, in case anyone wants to open it in a text editor
• Added note about how to use the search to README.md

0.2.1-alpha: 2020-11-25

Added

• TODO file

Changed

• Fixed gzip writing corrupt archives
• Changelog in README.md
• More debug_print
• Reordered config window
• make zip now zips into releases folder and numbered
• pydevd_pycharm now handled more cleanly, with the PYDEVD variable

Removed

• if __name__ == "__main__" sections from main.py and config.py