[GUI Plugin] Reading Goal

[thiago.eec]

Originally Posted by ownedbycats

And I guess even if I did insert the starting date, it'd still have a massive jump. Hmm.

There's three things I can think of:

1. Average out the pages between the records instead of putting all the pages in on the date of new record.

2. A way to exclude pages from certain books?

3. Maybe ignore books that only have one date?

I'm working on a new dialog for editing the book's records. It's not saving the edits yet, but you can see how it's gonna work with the test version attached. Select the book and click on the new button on the right side of the 'Edit reading goal' dialog. I think this solves your problem and gives us a general way to deal with wrong records.

Originally Posted by Feoras

I would like to come back to this request, though except "alongside" I would like to have the option to change the main statistic view to show pages instead of the book count.
Sadly I do not read that many books a month, so having the pages read per month makes the statistic more useful to me.

Idea:
* Similar to `read_books_month_count` add a statistic for pages read per month.
* Have a config checkbox to change this setting.
* `get_month_stats` returns either the current count or the new pages count based on the checkbox

Working prototype git diff attached (inside zip).
(Might need some logic to now show the read books on month hover instead of pages (in `get_month_html`)


---
Another idea would be to expand the statistics view to have one with book read count and another next to it (like to the right) with the page count. This would probably the "alongside" request as original stated.


Anyway, thanks for considering any of this!

Thanks for the help!
In my testings, the code you provided got the wrong page count, though. For one thing, it was working with accumulated values:

read_pages_month_count[month] += read_page_count - last_year_pages_count

Note that this line is inside a 'for' loop, iterating over all books in the goal, so the 'read_page_count' refers to the whole year.
To get only the month values, I used the existing 'daily_page_count' method.

Anyway, test the version attached.

P.S.: Note what I wrote above, replying to @ownedbycats. There is an unfinished feature in this test version, but it doesn't affect any other feature or modify the database.

[ownedbycats]

I tried test version.

1. Noticed in Statistics dialog, hovering over graph shows '0' for pagecount.

2. Can't get the edit to work. For the single-record fic, I created a record, set it to one day before I completed and percent 99%. Pressing apply, it just... disappeared?

[thiago.eec]

Originally Posted by ownedbycats

I tried test version.

1. Noticed in Statistics dialog, hovering over graph shows '0' for pagecount.

Can you attatch a screenshot?

Originally Posted by ownedbycats

2. Can't get the edit to work. For the single-record fic, I created a record, set it to one day before I completed and percent 99%. Pressing apply, it just... disappeared?

I guess I wasn't clear enough. It's not finished yet, so it does nothing at the moment. It just displays the records.

Maybe I shouldn't send it like that. But only after I finished adding the new option I remembered I had started working on the new records dialog.

Tomorrow I'll send the working version.

[ownedbycats]

Include cursor:

[thiago.eec]

Originally Posted by ownedbycats

Include cursor:
Attachment 218123

That's really strange. I can't reproduce. It works fine here. Anyways, try the new test version below. It's fully functional now.

[thiago.eec]

New test version:

1) Now we have a records editor. You can add, remove and edit your records (except for the last one, matching your calibre library info). It works for any year. When you change the progress, the page count is calculated automatically.

2) Added a new option to the config: you can choose to show read books or read pages in the statistics dialog. The other info will be available hovering the bars.

[thiago.eec]

- Bug fix: sort the records dict treating the idx as integer, instead of text, avoiding the wrong order like '0, 1, 10 ,11, 2, 3,...9'

If you test this version, please leave your feedback. Does the page count show when hovering? Does the records editing work perfectly? Any other suggestions?

[Feoras]

Originally Posted by thiago.eec

- Bug fix: sort the records dict treating the idx as integer, instead of text, avoiding the wrong order like '0, 1, 10 ,11, 2, 3,...9'

If you test this version, please leave your feedback. Does the page count show when hovering? Does the records editing work perfectly? Any other suggestions?

Thank you so much for your work, adapting my proposal and making it even better.

Sadly it is not working for me. I think this might be a local thing.


The issue I could find out is, that the month names are lower case (from daily_page_count):

daily_page_count[m[_month].lower()][str(_day)] = 0

But inside get_month_stats function the read_pages_month_count is initialized from m

from calendar import month_abbr as m

However, these abbr are capital case.

This results in the for loop:
for month in daily_page_count to insert new month into read_pages_month_count instead of replacing the existing once.

This is how read_pages_month_count looks like after:

{'Jan': 0, 'Feb': 0, 'Mar': 0, 'Apr': 0, 'May': 0, 'Jun': 0, 'Jul': 0, 'Aug': 0, 'Sep': 0, 'Oct': 0, 'Nov': 0, 'Dec': 0, 'jan': 0, 'feb': 0, 'mar': 0, 'apr': 0, 'may': 0, 'jun': 0, 'jul': 0, 'aug': 573, 'sep': 231, 'oct': 0, 'nov': 0, 'dec': 0}

So either daily_page_count should not be lower case or month_page_stats has to be (but month_book_stats is not lower case either).

To be consistent I modified daily_page_count to be capitalized only in the function get_month_stats to be consistent with everything else:

def get_month_stats(self, _data: dict[str, dict]) -> tuple[dict[str, list], dict[str, list]]:
month_page_stats = {}
month_book_stats = {}

read_pages_month_count = {
m[1]: 0, m[2]: 0, m[3]: 0, m[4]: 0, m[5]: 0, m[6]: 0,
m[7]: 0, m[8]: 0, m[9]: 0, m[10]: 0, m[11]: 0, m[12]: 0
}
daily_page_count = self.daily_page_count()
daily_page_count = {k.capitalize(): v for k, v in daily_page_count.items()}

Now it works!
Pages are shown correctly and books read when hovering if the settings is set or vise verse if not.

Sorry for the long post and thanks again for implementing this feature <3

[thiago.eec]

Originally Posted by Feoras

Thank you so much for your work, adapting my proposal and making it even better.

Sadly it is not working for me. I think this might be a local thing.


The issue I could find out is, that the month names are lower case (from daily_page_count):


But inside get_month_stats function the read_pages_month_count is initialized from m

However, these abbr are capital case.

This results in the for loop:
for month in daily_page_count to insert new month into read_pages_month_count instead of replacing the existing once.

This is how read_pages_month_count looks like after:


So either daily_page_count should not be lower case or month_page_stats has to be (but month_book_stats is not lower case either).

To be consistent I modified daily_page_count to be capitalized only in the function get_month_stats to be consistent with everything else:


Now it works!
Pages are shown correctly and books read when hovering if the settings is set or vise verse if not.

Sorry for the long post and thanks again for implementing this feature <3

Thanks so much for finding the problem. I tried appling your fix and noticed it stoped working for me. Then I checked the 'month_abbr' output. Turns out it's lowercase in pt-BR. God knows why!

So, to make sure it will always work, the best thing to do is to keep everything lowercase. So I did this:

read_pages_month_count = {k.lower(): v for k, v in read_pages_month_count.items()}

Now it is compatible with 'daily_page_count()'.

Please test and confirm it works.

[Feoras]

Originally Posted by thiago.eec

Thanks so much for finding the problem. I tried appling your fix and noticed it stoped working for me. Then I checked the 'month_abbr' output. Turns out it's lowercase in pt-BR. God knows why!

So, to make sure it will always work, the best thing to do is to keep everything lowercase. So I did this:

read_pages_month_count = {k.lower(): v for k, v in read_pages_month_count.items()}

Now it is compatible with 'daily_page_count()'.

Please test and confirm it works.

I was afraid this would be a locale thing.

Sadly, this does not work.

1. In "get_month_html" function to create "bar" you access m[i] which is still upper case.
So this works:

                    if prefs['pages_instead_of_books']:  # Read pages
                        bar = month_bar.format(month_pages_stats[m[i].lower()][0], month_pages_stats[m[i].lower()][1],
                                               '<a href="http://reading_goal/' + m[i].lower() + '">' + m[i] + '</a>',
                                               str(month_books_stats[m[i].lower()][0]))
                    else:  # Read books
                        bar = month_bar.format(month_books_stats[m[i].lower()][0], month_books_stats[m[i].lower()][1],
                                               '<a href="http://reading_goal/' + m[i].lower() + '">' + m[i] + '</a>',
                                               str(month_pages_stats[m[i].lower()][0]))

only keeping the display of m[i] as is for a correct display to the user.

2. Also an error when updating a book in the function "update_summary"

                    if data[book_id]['status'] == 100:
                        read_books_count += 1
                        month = data[book_id]['date'].astimezone().strftime('%b')
                        read_books_month_count[month] += 1

month is uppercase, while the data is now lowercase.
so this I had to change to:

                        month = data[book_id]['date'].astimezone().strftime('%b').lower()

With these two changes everything seemed to work. I tried to use all the features and no error was thrown anymore.
----
Is it really necessary to use lowercase? I think it might be easily missable somewhere which might result in an error. But maybe removing lowercase everywhere will also result in other errors ...

Another idea would be to use a new, forced lower case dict of the month abbreviation list ... like defining a global:

ml = [month.lower() for month in m]

and then use ml instead of m everywhere, which will result in all data/keys to be lowercase without having to call lower() everywhere. Well, except where the date is obtained from the timezone as in codeblock 2.
And then only use m when displaying it to the user, e.g. in "'">' + m[i] + '</a>'"

----
Anyways, fixing the 2 codeblocks as described above worked for me so far.
Again, thank you so much!

[thiago.eec]

Originally Posted by Feoras

I was afraid this would be a locale thing.

Sadly, this does not work.

What a nightmare. Thanks for the help!

Originally Posted by Feoras

Is it really necessary to use lowercase? I think it might be easily missable somewhere which might result in an error. But maybe removing lowercase everywhere will also result in other errors ...

Another idea would be to use a new, forced lower case dict of the month abbreviation list ... like defining a global:

ml = [month.lower() for month in m]

and then use ml instead of m everywhere, which will result in all data/keys to be lowercase without having to call lower() everywhere. Well, except where the date is obtained from the timezone as in codeblock 2.
And then only use m when displaying it to the user, e.g. in "'">' + m[i] + '</a>'"

----
Anyways, fixing the 2 codeblocks as described above worked for me so far.
Again, thank you so much!

I like the idea of using 'ml' instead of 'm'. I'll check it. In any case, we already have a fix. Thank you very much.

[thiago.eec]

I hope this is the last test version before the release.
I added the fix from @Feoras.

[ownedbycats]

Originally Posted by thiago.eec

I hope this is the last test version before the release.
I added the fix from @Feoras.

Some things:
1. Can make new record, but can't edit pagecount on it?
2. Also couldn't make record for different year.
3. As my Calibre viewer pagecount tends to differ a bit from what Page Count calculates, option to put in percentage would be helpful.

[thiago.eec]

Originally Posted by ownedbycats

Some things:
1. Can make new record, but can't edit pagecount on it?

When you edit the progress (%), the page count is updated automatically.

Originally Posted by ownedbycats

2. Also couldn't make record for different year.

Every year has their own database.
If you want to create a record for another year (let's say 2024), first select this year in combobox; then open the records editor and create the record.
------
Edit:
Just noticed that the date column is misconfigured, only accepting 2025's dates. I'll fix this.

Originally Posted by ownedbycats

3. As my Calibre viewer pagecount tends to differ a bit from what Page Count calculates, option to put in percentage would be helpful.

Put the percentage where? In the record editor, you edit the percentage and the date (the total page count for the book comes from your calibre library, and the partial page count is calculated based on the percentage inserted).

[thiago.eec]

Bug fix: when adding a record for a different year, the plugin still locked the date to the current year