[GUI Plugin] Annotations

[bopuc]

Originally Posted by bopuc

Hm, investigating.

[Update]
Indeed it seems Github's automatic source code zip places the files into a directory before zipping.
Interestingly, when unzipping the "correct" plugin zip, in some cases the app doing the unzipping will also create a folder. That's why I didn't catch it.

Noted! I will figure out how to produce a usable release package.

Thank you DNSB!

Happy to report I figured that out quickly.
Releases from the github repo will now contain a properly zipped plugin file.

https://github.com/calibre-annotatio.../tag/v1.17.16b

At a minimum this installs correctly and all previous functionality should remain.

[bopuc]

Originally Posted by aik099

1. Would this work for Calibre 8.x as well?
2. Are you making these changes to the https://github.com/PeterJT/calibre-annotations as well?
3. I've noticed a massive line-ending change (from \n to \r\n). Not sure if that was intentional.
4. what about these changes (see the screenshot from Sublime Merge), that are absent in every uploaded "Annotations.zip", but present on GitHub Repo (see https://github.com/davidfor/calibre-...c8429f7652fec1). I guess David forgot to make a releases including them:

https://cln.sh/NFJbV95fQJ887llmMxr4

5. These changes in the "reader_app_support.py" seem to be inconsistent (the "\\W" instead of "\W"; see screenshot):

https://cln.sh/0lxtd9tTkQSRYr91WF24

I suggest:

- updating the "about.txt" to keep track of the changes in a particular version
- use GitHub repo to make changes & releasing to have a single source of truth

Thank you.

P.S.
I can try sending PRs with all that stuff, and we'll continue code-related discussions there. Easier this way, than doing putting code screenshots in here.

Hello!

- I rolled davidfor's unreleased changes from his "master" branch" into the repo I am proposing we use, here:
https://github.com/calibre-annotations/Annotations/

- I fixed the "\\W" bug

- NL/LF and indentation format will get harmonized when I get around to a cleanup. This should not affect the code's execution though.


Issues and PR's welcome!

[aik099]

Hello,

Just summarizing.

So we have 2 repos now:
- https://github.com/PeterJT/calibre-annotations - personal fork (started good, but then suddenly got unmaintained)
- https://github.com/calibre-annotations/Annotations/ - fork into organization (also a good start, hopefully would continue that way)

I wonder if we could arrange an official place. For example, move the https://github.com/davidfor/calibre-annotations (original repo) into organization and make sure Calibre would look in that repo.

Still a mystery to me how Calibre guesses where to look for plugin updates. That has to be automatics of some kind of with each release davidfor did manually uploaded that zip on Calibre servers.

I hope

[JSWolf]

Originally Posted by aik099

Hello,

Just summarizing.

So we have 2 repos now:
- https://github.com/PeterJT/calibre-annotations - personal fork (started good, but then suddenly got unmaintained)
- https://github.com/calibre-annotations/Annotations/ - fork into organization (also a good start, hopefully would continue that way)

I wonder if we could arrange an official place. For example, move the https://github.com/davidfor/calibre-annotations (original repo) into organization and make sure Calibre would look in that repo.

Still a mystery to me how Calibre guesses where to look for plugin updates. That has to be automatics of some kind of with each release davidfor did manually uploaded that zip on Calibre servers.

I hope

calibre doesn't look at any GIT repo. So that's not an issue. What's needed is a new thread for the new version and a new pointer in the index to point to the new thread.

[bopuc]

Originally Posted by aik099

Hello,

Just summarizing.

So we have 2 repos now:
- https://github.com/PeterJT/calibre-annotations - personal fork (started good, but then suddenly got unmaintained)
- https://github.com/calibre-annotations/Annotations/ - fork into organization (also a good start, hopefully would continue that way)

I wonder if we could arrange an official place. For example, move the https://github.com/davidfor/calibre-annotations (original repo) into organization and make sure Calibre would look in that repo.

Still a mystery to me how Calibre guesses where to look for plugin updates. That has to be automatics of some kind of with each release davidfor did manually uploaded that zip on Calibre servers.

I hope

I am trying to do exactly that.

The code in https://github.com/calibre-annotations/Annotations/ is based on:
1. The last "master" branch of davidfor's repo (which means the last released plugin's code PLUS 2 unreleased commits.
2. All the code from the "hotfixes" that were posted here

Once I stabilize that codebase and the release process, I am entirely open to starting a new Thread here so that we can start releasing "directly to Calibre" (because IIUC, Calibre looks for plugins in a registry that Mr. Goval maintains with links to this forum).

I'm already squashing some bugs in the github release process, as well as cleaning up some cruft in the files. I've also just figured out how to re-enable translations.

v1.17.16 had a zipping bug.

v1.17.17 installs and functions correctly:
https://github.com/calibre-annotatio...s/tag/v1.17.17

[aik099]

Great completely agree, that all bug reports and discussions should really happen around the code on GitHub and not here. The GitHub also has Discussions feature.

[bopuc]

Originally Posted by keykid

Hi,

I have a fun idea to display my favourite quotes onto an e-ink monitor which I will put on my wall. I want to use the annotate function on my pocketbook to create a library. I see this plugin is not compatible with pocketbooks yet. Is this something anyone would be willing to look into?

Thanks

Hello keykid

The Pocketbook reader "plugin" was last committed to 4 years ago.
https://github.com/calibre-annotatio.../PocketBook.py
I don't have such a device myself so cannot test it but you could try and see.


Keep in mind that Annotations stores the annotations (and bookmarks and highlights) it fetches from a device into a Calibre "Custom Column" database table. From there it's pretty easy to use Calibre's API (or even raw SQLite) to fetch them and do whatever you want.

Do something similar to what you propose on my own site:
https://libra.re/screen/

Let us know how you get on.