[GUI Plugin] Reading Goal

[thiago.eec]

Originally Posted by Reader4106

• (read 35% ≙ Percentage of the read portion of the book

This is the info you need to fill in the reading progress column. It seems you are adding it to the comments section right now.

[ownedbycats]

PSA: Apply NTFS compression to the backup folder (if applicable). Compare Size and Size on Disk for comparison:

[Comfy.n]

Originally Posted by ownedbycats

PSA: Apply NTFS compression to the backup folder (if applicable). Compare Size and Size on Disk for comparison:

Attachment 215542

Screenshot reminds me of giving another chance to eXtra buttons, thanks. (I'd have it crashing now and then the first time I tried)

[Reader4106]

@thiago.eec

Thanks for the reply.
I'll try to get the plug-in up and running. We'll see if I can manage it.
After that, it will be a huge task to re-enter the required data from the 850 books I've already entered. Fingers crossed that it works.

(Translated from German using Google Translate)

[Reader4106]

(Translated from German using Google Translate)

Thanks to your help, I was able to install the plugin and get it working.
After entering the current year's data, everything worked perfectly.
I then started entering data from previous years. I also added some custom columns to Calibre.
Of course, I don't fully understand ReadingGoal yet. Besides data entry, I'm still exploring other features. For example, I still don't understand the purpose and functionality of "Challenges." More on that below.

I've skimmed through the many pages of this thread, but haven't found any answers.
I hope I'm not causing too much trouble.

Then, after entering more data, I receive the following error message when calling the "Statistics" function:

calibre, version 6.29.0
FEHLER: Unbehandelter Ausnahmefehler: <b>ValueError</b>:invalid literal for int() with base 10: 'Alle'

calibre 6.29 embedded-python: True
macOS-12.7.6-x86_64-i386-64bit Darwin ('64bit', '')
('Darwin', '21.6.0', 'Darwin Kernel Version 21.6.0: Mon Jun 24 00:56:10 PDT 2024; root:xnu-8020.240.18.709.2~1/RELEASE_X86_64')
Python 3.10.1
OSX: ('12.7.6', ('', '', ''), 'x86_64')
Interface language: de
Successfully initialized third party plugins: DeDRM (10, 0, 3) && Action Chains (1, 20, 10) && Annotations (1, 17, 13) && Count Pages (1, 13, 6) && Extract ISBN (1, 6, 5) && Favourites Menu (1, 3, 1) && Find Duplicates (1, 10, 9) && Import List (1, 9, 8) && Job Spy (1, 0, 239) && Library Codes (2, 0, 1) && Library Codes - SRU (2, 0, 4) && Manage Series (1, 5, 2) && Mass Search-Replace (1, 8, 2) && OverDrive Libby (0, 2, 3) && Pocketbook Tools (0, 10, 0) && Reading Goal (1, 9, 2) && Reading List (1, 15, 4) && Save To Format (0, 0, 6) && View Manager (1, 10, 3)
Traceback (most recent call last):
File "calibre_plugins.Reading_Goal.main", line 279, in manage_reading_goal
self.statistics_main(data)
File "calibre_plugins.Reading_Goal.main", line 3480, in statistics_main
ReadingGoalTools.show_statistics(self, tree, args)
File "calibre_plugins.Reading_Goal.main", line 3972, in show_statistics
d = ReadingGoalStatisticsDialog()
File "calibre_plugins.Reading_Goal.main", line 3493, in __init__
Dialog.__init__(self, _('Reading goal statistics'), 'plugin-reading-goal-stats-dialog', parent=tool.gui)
File "calibre/gui2/widgets2.py", line 225, in __init__
File "calibre_plugins.Reading_Goal.main", line 3560, in setup_ui
available_years = [year for year in available_years
File "calibre_plugins.Reading_Goal.main", line 3561, in <listcomp>
if int(year) <= datetime.datetime.now().astimezone().year]
ValueError: invalid literal for int() with base 10: 'Alle'

Calling the “Custom challenges” function results in the following error message:

„KeyError“:’summary’“

The detailed error message contains the following content:

calibre, version 6.29.0
FEHLER: Unbehandelter Ausnahmefehler: <b>KeyError</b>:'summary'

calibre 6.29 embedded-python: True
macOS-12.7.6-x86_64-i386-64bit Darwin ('64bit', '')
('Darwin', '21.6.0', 'Darwin Kernel Version 21.6.0: Mon Jun 24 00:56:10 PDT 2024; root:xnu-8020.240.18.709.2~1/RELEASE_X86_64')
Python 3.10.1
OSX: ('12.7.6', ('', '', ''), 'x86_64')
Interface language: de
Successfully initialized third party plugins: DeDRM (10, 0, 3) && Action Chains (1, 20, 10) && Annotations (1, 17, 13) && Count Pages (1, 13, 6) && Extract ISBN (1, 6, 5) && Favourites Menu (1, 3, 1) && Find Duplicates (1, 10, 9) && Import List (1, 9, 8) && Job Spy (1, 0, 239) && Library Codes (2, 0, 1) && Library Codes - SRU (2, 0, 4) && Manage Series (1, 5, 2) && Mass Search-Replace (1, 8, 2) && OverDrive Libby (0, 2, 3) && Pocketbook Tools (0, 10, 0) && Reading Goal (1, 9, 2) && Reading List (1, 15, 4) && Save To Format (0, 0, 6) && View Manager (1, 10, 3)
Traceback (most recent call last):
File "calibre_plugins.Reading_Goal.main", line 291, in manage_reading_goal
self.custom_challenges(db, data)
File "calibre_plugins.Reading_Goal.main", line 1845, in custom_challenges
d = CustomChallengesDialog()
File "calibre_plugins.Reading_Goal.main", line 1477, in __init__
Dialog.__init__(self, _('Custom challenges'), 'plugin-reading-goal-challenges-dialog', parent=tool.gui)
File "calibre/gui2/widgets2.py", line 225, in __init__
File "calibre_plugins.Reading_Goal.main", line 1521, in setup_ui
if 'challenges_dict' in goal_data[year]['summary']:
KeyError: 'summary'

I then took the following steps:

• Deleted all zero values ​​(0)
• Checked whether I had entered any other characters in columns where numbers were expected (exception: spaces, etc.)
  
• Even when entering the values, I noticed something strange. My PC's decimal separator is "." It requires the input as ",". Could this be the cause?
• The formatting of the required column "percentage_rg" has the following value: "{:.0f}%." Or is this the cause?

For the sake of completeness, there are screenshots of the other definitions.

[thiago.eec]

Originally Posted by Reader4106

Thanks to your help, I was able to install the plugin and get it working.
After entering the current year's data, everything worked perfectly.

Glad to hear you got it working.

Originally Posted by Reader4106

Of course, I don't fully understand ReadingGoal yet. Besides data entry, I'm still exploring other features. For example, I still don't understand the purpose and functionality of "Challenges." More on that below.

The Custom Challenges are meant to create a subset of your annual reading goal. You could create a "Fiction challenge", for instance; a "Sci-fi challenge", etc. Also, you can define a restricted time window (let's say three months for a certain challenge).

Originally Posted by Reader4106

I've skimmed through the many pages of this thread, but haven't found any answers.
I hope I'm not causing too much trouble.

No trouble at all. We all help each other here.

Originally Posted by Reader4106

Then, after entering more data, I receive the following error message when calling the "Statistics" function:

FEHLER: Unbehandelter Ausnahmefehler: <b>ValueError</b>:invalid literal for int() with base 10: 'Alle'

I can't reproduce that. And, to be honest, I don't understand how this is possible at all. Anyway, test the version attatched. It might solve the problem.

Originally Posted by Reader4106

Calling the “Custom challenges” function results in the following error message:

FEHLER: Unbehandelter Ausnahmefehler: <b>KeyError</b>:'summary'

Try the attatched version to see if this is fixed.

Originally Posted by Reader4106

I then took the following steps:

• Even when entering the values, I noticed something strange. My PC's decimal separator is "." It requires the input as ",". Could this be the cause?
• The formatting of the required column "percentage_rg" has the following value: "{:.0f}%." Or is this the cause?

This is just presentational. It makes no difference for the plugin.

[Reader4106]

Thanks thiago.eec for this quick reply.

Try the attatched version to see if this is fixed.

After installing the new version, I can access the statistics again. Thanks.

However, I can no longer access "Custom Challenges."

Attached is a screenshot of the error message.
And here is the detailed text of the error message:

calibre, version 6.29.0
FEHLER: Unbehandelter Ausnahmefehler: <b>KeyError</b>:'summary'

calibre 6.29 embedded-python: True
macOS-12.7.6-x86_64-i386-64bit Darwin ('64bit', '')
('Darwin', '21.6.0', 'Darwin Kernel Version 21.6.0: Mon Jun 24 00:56:10 PDT 2024; root:xnu-8020.240.18.709.2~1/RELEASE_X86_64')
Python 3.10.1
OSX: ('12.7.6', ('', '', ''), 'x86_64')
Interface language: de
Successfully initialized third party plugins: DeDRM (10, 0, 3) && Action Chains (1, 20, 10) && Annotations (1, 17, 13) && Count Pages (1, 13, 6) && Extract ISBN (1, 6, 5) && Favourites Menu (1, 3, 1) && Find Duplicates (1, 10, 9) && Import List (1, 9, 8) && Job Spy (1, 0, 239) && Library Codes (2, 0, 1) && Library Codes - SRU (2, 0, 4) && Manage Series (1, 5, 2) && Mass Search-Replace (1, 8, 2) && OverDrive Libby (0, 2, 3) && Pocketbook Tools (0, 10, 0) && Reading Goal (1, 9, 2) && Reading List (1, 15, 4) && Save To Format (0, 0, 6) && View Manager (1, 10, 3)
Traceback (most recent call last):
File "calibre_plugins.Reading_Goal.main", line 291, in manage_reading_goal
self.custom_challenges(db, data)
File "calibre_plugins.Reading_Goal.main", line 1845, in custom_challenges
d = CustomChallengesDialog()
File "calibre_plugins.Reading_Goal.main", line 1477, in __init__
Dialog.__init__(self, _('Custom challenges'), 'plugin-reading-goal-challenges-dialog', parent=tool.gui)
File "calibre/gui2/widgets2.py", line 225, in __init__
File "calibre_plugins.Reading_Goal.main", line 1521, in setup_ui
if 'challenges_dict' in goal_data[year]['summary']:
KeyError: 'summary'

When I tried to import more data, a message appeared stating that there were still records with empty fields.

I have empty fields for two groups of "books."

One group consists of reference books, dictionaries, atlases, guides, etc., which I started but never finished and therefore cannot specify a page number or percentage of the portion read.

I could simply move these books to the abandoned books. However, this doesn't seem correct to me, as they would be included in the statistics, which I don't think is right.
Here's a suggestion: What do you think about a new category for books like the ones mentioned above? I would also appreciate being able to specify which of the groups is used for which type of statistics calculation.

The second group consists of audiobooks.
As already mentioned in another post, I consider books I've listened to as read and don't differentiate between books I've read and books I've read. I often enjoy having books read to me while driving, doing gardening, or housework.

I'd like to ask you how you convert the "duration" (I store the value in whole minutes) into a page number. With e-books, the device's page count depends on various factors such as device type, font, font size, and other influences.

A conversion from the page count in the publisher's information for the paper editions might be possible. But even though I don't expect a particularly high level of accuracy from a conversion factor, I can only see a very complex way to calculate one. A factor would have to be calculated from the page count in the publisher's information and the reading time of the audiobook. Especially with nonfiction books with appendices such as glossaries, bibliographies, image sections, graphics, etc., these greatly distort the result. In German publishing, there's another issue. Many books have advertising sections for other books at the end, which are often more than 30 pages long and can further degrade the results.

I would be very grateful for any tips.

This question should probably be discussed elsewhere. Sorry.

In any case, I'm looking forward to your answers. Thank you.

(Translated from German using Google Translate)

[thiago.eec]

Originally Posted by Reader4106

However, I can no longer access "Custom Challenges."

Please send me the database file so I can better understand what's going on. You can send it here with a .txt extension or via private message.

Originally Posted by Reader4106

When I tried to import more data, a message appeared stating that there were still records with empty fields.

You can have empty fields, as long as the reading percentage is less than 100%. If a book is 100% read, then you must inform the page count and the finish date.

Originally Posted by Reader4106

I'd like to ask you how you convert the "duration" (I store the value in whole minutes) into a page number.

I have a column with the average reading time for all my books based on the word count / page count. It uses the word count (generated by the Page Count plugin) to calculate the reading time. In case there is no word count, it uses the page count. I use an average reading speed of 260 words/min (or 50 pages/hour).

So, if you have the duration and want to convert to a page count, you could just multiply the duration by your reading speed (in pages/hour).

[Reader4106]

That was quick. Thanks.

I hope I found the right file. The .Jason file is attached and in the desired txt format.
While formatting the file, I came across two entries that seem very strange to me. In the database, they have the entries "9307": { and "9308": {.
These are two copies of the same issue of a magazine in PDF format. I made annotations in one of them. Invisible characters are appended or inserted to the title of both issues. I can't figure out where these characters come from.

That's why I'm sending two screenshots of the book information for both copies.
Could these two entries be causing the problem?

Thanks also for the other information. They explain a lot.
I'll look into the missing entries where necessary.
I'll also take care of the audiobooks at a later date.

I considered removing the two journal entries from ReadingGoal. When I tried, I was asked if I really wanted to do that, as it couldn't be undone. I then abandoned the attempt.
What would I have lost if I had deleted them?
And couldn't I have simply added them back later?
Another thought: What would happen if I first cleaned up all Calibre entries and completed them as much as possible. Then removed and reinstalled the ReadingGoal plugin?
Would that work, and would there be any benefit?

[thiago.eec]

Originally Posted by Reader4106

While formatting the file, I came across two entries that seem very strange to me.

When you say you were formatting the file, do you mean you manually edited the file? That is not advised. Most of the time it leads to database corruption.

I see your database has an 'Alle' (german for 'All') key. I don't see how this is possible except for manual edit. But if you didn't edit the file, it may be a bug that only happens under very specific circustances, as others never came across it. In the JSON database, the main keys should be years (... 2023, 2024, 2025, and a 'general_info' key at the end).

Originally Posted by Reader4106

In the database, they have the entries "9307": { and "9308": {.
These are two copies of the same issue of a magazine in PDF format. I made annotations in one of them. Invisible characters are appended or inserted to the title of both issues. I can't figure out where these characters come from.
That's why I'm sending two screenshots of the book information for both copies.
Could these two entries be causing the problem?

No. Each ID is considered a diferent book by calibre and by the plugin. If you see both 9307 and 9308, then you added both to your reading goal. Reading Goal makes no change to your calibre library. The plugin only edit its own database.

Originally Posted by Reader4106

I considered removing the two journal entries from ReadingGoal. When I tried, I was asked if I really wanted to do that, as it couldn't be undone. I then abandoned the attempt.
What would I have lost if I had deleted them?
And couldn't I have simply added them back later?

When you add a book you want to read, it has a initial date and a 0% status. Then, as you keep reading, every time you update the reading percentage, a new record is created inside that book. You can see them by selecting the book and clicking in the far inline right buttom. So, if you delete a book that has records, they will be lost forever. If the book has no record, then you could just add it back, and no harm would be done.

Originally Posted by Reader4106

Another thought: What would happen if I first cleaned up all Calibre entries and completed them as much as possible. Then removed and reinstalled the ReadingGoal plugin?
Would that work, and would there be any benefit?

Unless you think your data is severely wrong, I wouldn't recommed that. It's a lot of work. I edited your JSON file removing the 'Alle' key. Now it should work normally and you can continue adding books.

*PS.: Just rename the file from 'Reading_Goal_mbr.txt' to 'Reading_Goal_mbr.json', then import via 'Database > Import' button.

[Reader4106]

Thanks for the answers.
I haven't understood everything yet, but that's not due to my lack of English.
I'll be working with the plug-in for a while now; hopefully, it will explain a few things to me.

When you say you were formatting the file, do you mean you manually edited the file? That is not advised. Most of the time it leads to database corruption.

I haven't changed anything in the JSON database. I noticed the oddity when I converted it from JSON to TXT.

I see your database has an 'Alle' (german for 'All') key. I don't see how this is possible except for manual edit. But if you didn't edit the file, it may be a bug that only happens under very specific circustances, as others never came across it. In the JSON database, the main keys should be years (... 2023, 2024, 2025, and a 'general_info' key at the end).

I can't say where the "All" option comes from. But I really appreciate it.

Now, one last question (for now): How can I enter the data for a book for rereading? And as a follow-up question, can the rereading function also be applied to unfinished books?

Despite my many questions, I would like to mention how much I like the plug-in and thank you for your work.

[thiago.eec]

Originally Posted by Reader4106

I haven't changed anything in the JSON database. I noticed the oddity when I converted it from JSON to TXT.

Then it must be a bug, but I don't know how it happened. I'll investigate to see if I can reproduce. It must happen with a new database, under certain conditions.

Originally Posted by Reader4106

I can't say where the "All" option comes from. But I really appreciate it.

When you choose 'All' in the dropdown menu, the plugin gathers all the years' information and present it to the user. But, there is no 'All' entry in the JSON, it's created at execution time, internally.

Originally Posted by Reader4106

Now, one last question (for now): How can I enter the data for a book for rereading? And as a follow-up question, can the rereading function also be applied to unfinished books?

After you finish a book, if your start reading it again the plugin will mark it as 'Rereading' automatically. You don't have to do anything special, except start reading it.

Originally Posted by Reader4106

Despite my many questions, I would like to mention how much I like the plug-in and thank you for your work.

Thanks.

[ownedbycats]

I used my "mark as read" chain (sets date + 100%) on the wrong book. I cleared the date and set back to 0% and then removed the record. Now I have two undated 0% records and neither can be removed.

    "9292": {
      "authors": [
        "AstroGold"
      ],
      "challenges": [
        "Annual"
      ],
      "date": null,
      "genre": [
        "Fanfiction.Star Trek"
      ],
      "last_year_pages": 0,
      "page_count": 30,
      "read_pages": 0,
      "records": {
        "0": {
          "date": null,
          "read_pages": 0,
          "status": 0
        },
        "2": {
          "date": null,
          "read_pages": 0,
          "status": 0
        }
      },
      "reread_count": -1,
      "series": null,
      "shelf": "Want to read",
      "status": 0,
      "title": "The Great Irish Penny-Farthing Bike Race: Delta Quadrant Edition",
      "title_sort": "Great Irish Penny-Farthing Bike Race: Delta Quadrant Edition, The"
    },

I was able to just remove + re-add the book, but seems a bug.

[thiago.eec]

Originally Posted by ownedbycats

Now I have two undated 0% records and neither can be removed.

The last record can't be removed. And since those two records are identical (null date and 0%), then neither can be removed. After you add a new record, those can be deleted.