[GUI Plugin] Skoob Sync

[thiago.eec]

ALERT: The plugin stopped working after Skoob added a Cloudflare protection to the login page. Despite all my efforts, I could not find a way to bypass this protection. If I find a way to solve this, I'll let you know.

ALERTA: O plugin parou de funcionar depois que o Skoob adicionou uma proteção Cloudflare à página de login. Apesar de todos os meus esforços, não consegui encontrar uma maneira de contornar essa proteção. Caso encontre uma maneira de resolver isso, eu aviso.

Skoob Sync allows you to synchronize your book collection in calibre with your Skoob account.

Skoob is a Brazilian website similar to Goodreads. Although the plugin interface is also available in English, the website is pt_BR only. For that reason, this plugin will be of most use for portuguese readers.

This plugin was based on Goodreads Sync.

Main Features:

• Sync reading progress, status date, rating, and reviews with Skoob
• Get the book page count
• Get User defined tags. Obs.: Limited to 20 books, due to performance.
• Get book media type (physical or digital)
• Add/remove books to/from your Skoob account
• Add, remove and reorganize books in your shelves
• Add book to Reading Goal
• Get the Read Date (when the book was finished)
• See your Reading Goal statistics for the last 10 years
• Import your Library from Skoob to calibre (create empty books)
• List all your books with a Skoob ID
• Bulk operation: up to 50 books at a time

Syncing a Review:

• Downloading: When you download your review from Skoob, it can be saved within the comments field or on a separate custom column. If you choose to save it with comments, then it will be added at the bottom of the existing comments, with a '#### Skoob ####' separator. If your review has a title, it will be shown in bold.
• Uploading: You can also write a review on calibre and sync it with your Skoob account. To do so, you can use a custom column (type: comments) to store it. If you want your review to have a title on Skoob, then you must edit your html code using this pattern: <h4>Your title in here</h4><p>Your review in here</p>. But that's not mandatory (just in case you want to set a title for it). P.S.: Mutiple <p> elements are supported.

Requirements:

• calibre 2.50 or later
• In order for this plugin to work, every book you want to synchronize must have a Skoob ID. You can get it with Skoob Books Metadata Source Plugin, or importing your Skoob Library to calibre using this plugin.

Installation Steps:

1. Download the attached zip file and install the plugin/add to context menu or toolbar/restart calibre as described in the Introduction to plugins thread.
2. Click on "Customize plugin" on the menu and fill in your Skoob credentials. This option is also available via the Preferences->Plugins dialog once you select it within the list.
3. Choose the sync actions you want the plugin to perform when Uploading to or Downloading from Skoob.
4. Choose the custom column for each of those actions.
5. With calibre 5.35 or later, you can create each custom column with just two clicks, directly from plugin's configuration dialog. Do not close the configuration dialog until you have finished creating your columns, so you only restart calibre once.
6. Now you are able to start syncing. Enjoy!

Getting Help:

If you need assistance using this plugin, you can check out the built-in help dialogs by clicking on the '?' icon in the upper right corner of the dialog window. Then, hover your mouse over the options, and click when the cursor changes to an arrow and a question mark.

If any doubt still persists, feel free to ask here. Also, suggestions are welcomed!

Latest calibre version tested: 7.8

Version History:

Spoiler:

Version 0.5.5 - 19 Feb 2024
- New feature: mark books as Favorite, Wanted, Owned, Lent, Exchange

Version 0.5.4 - 24 Jul 2023
- Code refactoring
- Bug fix: Reading Goal statistics: fix the monthly reading graph displaying the wrong height for highest bar
- Other bug fixes

Version 0.5.3 - 22 Apr 2023
- Reading Goal statistics: added monthly reading graph (calibre 6.0+ only)
- Reading Goal statistics: added general ranking position

Version 0.5.2 - 08 Mar 2023
- Add synopsis to comments, when importing new books from Skoob Library

Version 0.5.1 - 14 Jan 2023
- New feature: See your Reading Goal statistics for the last 10 years

Version 0.5.0 - 10 Aug 2022
- Add support for themed versions of icons (-for-dark-theme / -for-light-theme)

Version 0.4.9 - 12 Jul 2022
- Bug fix: some icons were not automatically changing
- Bug fix: activate What's This on the Skoob Library dialog

Version 0.4.8 - 12 Jul 2022
- Bug fix: a window flag was causing the config dialog to move every time it was loaded

Version 0.4.7 - 11 Jul 2022
- Add support for automatic Dark and Light theme change
- Add a new set of icons for Dark theme (Blue)
- Minor bug fixes

Version 0.4.4 - 12 Jan 2022
- Config dialog redesigned to use tabs
- Introduction of help dialogs using "What's This"
- Added keyboard shortcuts management
- Code adjustments to drop minimum version from 3.10 to 2.50

Version 0.4.3 - 07 Jan 2022
- Fix incorrect tooltip for themes

Version 0.4.2 - 07 Jan 2022
- UI code refactoring
- Theme improvement: no need to restart calibre to apply changes

Version 0.4.1 - 05 Jan 2022
- PyQt6 support
- New feature: add your custom columns directly from plugin's configuration dialog
- Bug fix: do not mess columns configuration when new custom columns of the same type are created

Version 0.4.0 - 29 Out 2021
- Improve handling of internet connection
- Change password icon for better contrast
- Prevent 'Connecting to Skoob' message when cookie is still valid

Version 0.3.9 - 01 Feb 2021
- Detect when Skoob is down for maintenance
- Start using headers for requests, since Skoob is now blocking all requests without a header
- Small improvements and minor bug fixes

Version 0.3.6 - 01 Dec 2020
- Set read date as today, when uploading read percentage to Skoob
- Bug fixes

Version 0.3.5 - 07 Sep 2020
- Fix for line breaks on Review. Now, you can use multiple <p> elements on your review on calibre. Also, when downloading, line breaks will be preserved.

Version 0.3.4 - 07 Mar 2020
- Fix regression caused by last update.

Version 0.3.3 - 07 Mar 2020
- Fix for expired cookies forcing the user to restart calibre to obtain a new valid one.

Version 0.3.2 - 26 Fev 2020
- Changed method to get cover images. Skoob was blocking simple requests, with default header.

Version 0.3.1 - 02 Jan 2020
- When using 'Send to Skoob', the book media type (digital or physical) is also updated on Skoob website.

Version 0.3.0 - 19 Dez 2019
- Update code to support python 2/3.
- Skip Dark Mode detection on old versions of calibre

Version 0.2.9 - 12 Dez 2019
- Another small adjust for Dark Mode

Version 0.2.8 - 11 Dez 2019
- Visual adjusts for calibre new Dark Mode for Windows 10
- New icon theme: Light Grey and Yellow. It can be selected in Customize plugin > Customize interface > Icons. For new users, this is the default theme when Dark Mode is active on calibre.

Version 0.2.7 - 18 Out 2019
- Fix multi-thread bug causing calibre to crash

Version 0.2.6 - 17 Out 2019
- New option: Add a book to the Reading Goal
- New option: Get just the Read Date of a book
- New option: Get user tags for a book
- New feature: Get book media type (physical ou digital)

Version 0.2.5 - 06 Out 2019
- Fix Skoob ID striping when uppercase letters are present

Version 0.2.4 - 04 Out 2019
- Small change on handling reviews, so it will work on calibre 4

Version 0.2.3 - 29 Sep 2019
- Fix empty rating being send to Skoob (which creates a pointless post on user feed)

Version 0.2.2 - 26 Sep 2019
- Fix a bug on multiple attempts to login, when there is no internet connection

Version 0.2.1 - 23 Sep 2019
- Allows selection with arrows keys on the Skoob Library widget.
- Bug fixes

Version 0.2.0 - 18 Sep 2019
- Added the option to Import you Skoob Library to calibre, creating empty books (with cover and basic metadata).
- Improved Skoob access

Version 0.1.0 - 12 Sep 2019
Initial release of Skoob Sync plugin

[thiago.eec]

# Saved for future further instructions #

[thiago.eec]

Version 0.2.0 - 18 Sep 2019

- Added the option to Import you Skoob Library to calibre, creating empty books (with cover and basic metadata).
- Improved Skoob access

[thiago.eec]

Version 0.2.1 - 23 Sep 2019
- Allows selection with arrows keys on the Skoob Library widget.
- Bug fixes

[thiago.eec]

Version 0.2.2 - 26 Sep 2019

- Fix a bug on multiple attempts to login, when there is no internet connection

[thiago.eec]

Version 0.2.4 - 04 Out 2019

- Small change on handling reviews, so it will work on calibre 4

[thiago.eec]

Version 0.2.6 - 17 Out 2019

- New option: Add a book to the Reading Goal
- New option: Get just the Read Date of a book
- New option: Get user tags for a book
- New feature: Get book media type (physical ou digital)

[thiago.eec]

Version 0.2.8 - 11 Dez 2019

- Visual adjusts for calibre new Dark Mode for Windows 10
- New icon theme: Light Grey and Yellow. It can be selected in Customize plugin > Customize interface > Icons. For new users, this is the default theme when Dark Mode is active on calibre.

[thiago.eec]

Version 0.3.0 - 19 Dez 2019

- Update code to support python 2/3.
- Skip Dark Mode detection on old versions of calibre

[thiago.eec]

Version 0.3.1 - 02 Jan 2020

- When using 'Send to Skoob', the book media type (digital or physical) is also updated on Skoob website.

[thiago.eec]

Version 0.3.2 - 26 Fev 2020

- Changed method to get cover images. Skoob was blocking simple requests, with default header.

[thiago.eec]

Version 0.3.3 - 07 Mar 2020

- Fix for expired cookies forcing the user to restart calibre to obtain a new valid one.

[thiago.eec]

Version 0.3.5 - 07 Sep 2020

- Fix for line breaks on Review. Now, you can use multiple <p> elements on your review on calibre. Also, when downloading, line breaks will be preserved.

[thiago.eec]

Version 0.3.6 - 01 Dec 2020

- Set read date as today, when uploading read percentage to Skoob
- Bug fixes

[thiago.eec]

Version 0.3.9 - 01 Feb 2021

- Detect when Skoob is down for maintenance
- Start using headers for requests, since Skoob is now blocking all requests without a header
- Small improvements and minor bug fixes