[ELPA] New package: calibre.el

[ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 627 bytes --]

I am currently working on a package to interact with Calibre
(https://calibre-ebook.com/).  The repository can be found here:
https://git.disroot.org/kjartanoli/calibre.el.  Would there be any
interest in adding it to GNU ELPA? And if so, is my copyright assignment
for Emacs sufficient, or does ELPA require a separate assignment?

This is my first attempt at writing an Emacs package, so I expect to
have gotten many things wrong.  As such I would welcome reviews from
people who know more about Elisp packaging.

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]

Re: [ELPA] New package: calibre.el

[Philip Kaludercic]

Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:

> I am currently working on a package to interact with Calibre
> (https://calibre-ebook.com/).  The repository can be found here:
> https://git.disroot.org/kjartanoli/calibre.el.  

Sounds interesting!

>                                                 Would there be any
> interest in adding it to GNU ELPA? And if so, is my copyright assignment
> for Emacs sufficient, or does ELPA require a separate assignment?

No separate assignment is necessary, as GNU ELPA packages are regarded
to be part of Emacs.

> This is my first attempt at writing an Emacs package, so I expect to
> have gotten many things wrong.  As such I would welcome reviews from
> people who know more about Elisp packaging.

The first thing to note is that you don't need a -pkg.el file.  ELPA
will generate one for you using the metadata in the main file and
overwrite whatever you have written.

This means you should copy the metadata to calibre.el.  Especially the
dependency list.  (Also, why do you depend on "29.1.0", a version which
is unreleased and has an additional ".0" at the end?  I guess you need
Emacs 29 because of SQLite?  Have you taken a look at emacsql?)

From a brief skim of the code, it looks more or less fine.  There are
minor things I am not sure about (such as the usage of eieio or why you
declare some functions instead of requiring the file).

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

Thank you for taking the time to look at it.

>>                                                 Would there be any
>> interest in adding it to GNU ELPA? And if so, is my copyright assignment
>> for Emacs sufficient, or does ELPA require a separate assignment?
>
> No separate assignment is necessary, as GNU ELPA packages are regarded
> to be part of Emacs.

Good to know.

>> This is my first attempt at writing an Emacs package, so I expect to
>> have gotten many things wrong.  As such I would welcome reviews from
>> people who know more about Elisp packaging.
>
> The first thing to note is that you don't need a -pkg.el file.  ELPA
> will generate one for you using the metadata in the main file and
> overwrite whatever you have written.

Another good to know.  I remember reading that somewhere, but then I
looked at some other packages that seemed to maintain a -pkg.el file.

> This means you should copy the metadata to calibre.el.  Especially the
> dependency list.  (Also, why do you depend on "29.1.0", a version which
> is unreleased and has an additional ".0" at the end?  I guess you need
> Emacs 29 because of SQLite?  Have you taken a look at emacsql?)

I'll definitely fix the .0 thing.  You are correct that the dependency
on Emacs 29 is for SQLite.  Emacsql would not work, since I am
interacting with an existing database maintained by Calibre.  If you
want to wait until Emacs 29 is released to add it I would definitely
agree to that.

> From a brief skim of the code, it looks more or less fine.  There are
> minor things I am not sure about (such as the usage of eieio or why you
> declare some functions instead of requiring the file).

The functions that are declared instead of required currently cause a
recursive require because of how the package is structured.  I am hoping
to refactor this soon.

As for the usage of eieio, is there a reason not to use it?

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

Re: [ELPA] New package: calibre.el

[dalanicolai]

[-- Attachment #1: Type: text/plain, Size: 2851 bytes --]

Hey Kjartan, nice to see you writing packages and contributing to Emacs now.

This sounds interesting indeed, but it would be nice if you could add some
(more) explanation about the
 package in the repo its README and/or in the initial comment of the
calibre.el file.

Also, I am using the very mature calibredb.el
<https://github.com/chenyanming/calibredb.el> package for a few years
already. Are you already aware
of its existence? If so, besides that that package is only available from
Melpa, could you explain why you
wrote this similar alternative package?

Anyway, thanks for sharing your package! And nice job!

On Tue, 18 Apr 2023 at 10:36, Kjartan Óli Águstsson <kjartanoli@outlook.com>
wrote:

> Thank you for taking the time to look at it.
>
> >>                                                 Would there be any
> >> interest in adding it to GNU ELPA? And if so, is my copyright assignment
> >> for Emacs sufficient, or does ELPA require a separate assignment?
> >
> > No separate assignment is necessary, as GNU ELPA packages are regarded
> > to be part of Emacs.
>
> Good to know.
>
> >> This is my first attempt at writing an Emacs package, so I expect to
> >> have gotten many things wrong.  As such I would welcome reviews from
> >> people who know more about Elisp packaging.
> >
> > The first thing to note is that you don't need a -pkg.el file.  ELPA
> > will generate one for you using the metadata in the main file and
> > overwrite whatever you have written.
>
> Another good to know.  I remember reading that somewhere, but then I
> looked at some other packages that seemed to maintain a -pkg.el file.
>
> > This means you should copy the metadata to calibre.el.  Especially the
> > dependency list.  (Also, why do you depend on "29.1.0", a version which
> > is unreleased and has an additional ".0" at the end?  I guess you need
> > Emacs 29 because of SQLite?  Have you taken a look at emacsql?)
>
> I'll definitely fix the .0 thing.  You are correct that the dependency
> on Emacs 29 is for SQLite.  Emacsql would not work, since I am
> interacting with an existing database maintained by Calibre.  If you
> want to wait until Emacs 29 is released to add it I would definitely
> agree to that.
>
> > From a brief skim of the code, it looks more or less fine.  There are
> > minor things I am not sure about (such as the usage of eieio or why you
> > declare some functions instead of requiring the file).
>
> The functions that are declared instead of required currently cause a
> recursive require because of how the package is structured.  I am hoping
> to refactor this soon.
>
> As for the usage of eieio, is there a reason not to use it?
>
> --
> Kjartan Oli Agustsson
> GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0
>
>

[-- Attachment #2: Type: text/html, Size: 3491 bytes --]

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 1156 bytes --]


dalanicolai <dalanicolai@gmail.com> writes:

> Hey Kjartan, nice to see you writing packages and contributing to Emacs now.
>
> This sounds interesting indeed, but it would be nice if you could add some (more) explanation about the
>  package in the repo its README and/or in the initial comment of the calibre.el file.

Most definitely.  So far I've mostly been focusing on making sure the
code works.  Now that I seem to have achieved a small, but usable,
feature set I'll probably put more focus on documentation.

> Also, I am using the very mature calibredb.el package for a few years already. Are you already aware
> of its existence? If so, besides that that package is only available from Melpa, could you explain why you
> wrote this similar alternative package?

Yes, I am aware of calibredb.  I wasn't the biggest fan of the interface
(that probably stems from unfamiliarity more than anything), so I
thought it would be fun to try writing my own.

> Anyway, thanks for sharing your package! And nice job!

Thank you.

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]

Re: [ELPA] New package: calibre.el

[Philip Kaludercic]

Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:

>>> This is my first attempt at writing an Emacs package, so I expect to
>>> have gotten many things wrong.  As such I would welcome reviews from
>>> people who know more about Elisp packaging.
>>
>> The first thing to note is that you don't need a -pkg.el file.  ELPA
>> will generate one for you using the metadata in the main file and
>> overwrite whatever you have written.
>
> Another good to know.  I remember reading that somewhere, but then I
> looked at some other packages that seemed to maintain a -pkg.el file.

It is a common mistake or a MELPA-ism I don't know about ^^.

> As for the usage of eieio, is there a reason not to use it?

If you just need a structure then cl-defstruct should be a less-heavy
solution.

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 566 bytes --]


Philip Kaludercic <philipk@posteo.net> writes:

>> As for the usage of eieio, is there a reason not to use it?
>
> If you just need a structure then cl-defstruct should be a less-heavy
> solution.

Noted, I'm hoping to add the ability to edit metadata in the future, and
from the small experiments I've done eieio-customize-object looks
useful, since it means I don't have to write the UI for that editing. So
I'll probably stick with EIEIO for now.

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 1129 bytes --]


Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:

>> This means you should copy the metadata to calibre.el.  Especially the
>> dependency list.  (Also, why do you depend on "29.1.0", a version which
>> is unreleased and has an additional ".0" at the end?  I guess you need
>> Emacs 29 because of SQLite?  Have you taken a look at emacsql?)
>
> I'll definitely fix the .0 thing.  You are correct that the dependency
> on Emacs 29 is for SQLite.  Emacsql would not work, since I am
> interacting with an existing database maintained by Calibre.  If you
> want to wait until Emacs 29 is released to add it I would definitely
> agree to that.

I've done some more work on this.  The most significant one being the
addition of a backend/database interface that uses the calibredb
executable instead of parsing the SQLite database directly.  Combined
with compat this should lower the minimum required Emacs version to 27.
Are there any other things that would block calibre.el's inclusion in
GNU ELPA?

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]

Re: [ELPA] New package: calibre.el

[Philip Kaludercic]

Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:

> Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:
>
>>> This means you should copy the metadata to calibre.el.  Especially the
>>> dependency list.  (Also, why do you depend on "29.1.0", a version which
>>> is unreleased and has an additional ".0" at the end?  I guess you need
>>> Emacs 29 because of SQLite?  Have you taken a look at emacsql?)
>>
>> I'll definitely fix the .0 thing.  You are correct that the dependency
>> on Emacs 29 is for SQLite.  Emacsql would not work, since I am
>> interacting with an existing database maintained by Calibre.  If you
>> want to wait until Emacs 29 is released to add it I would definitely
>> agree to that.
>
> I've done some more work on this.  The most significant one being the
> addition of a backend/database interface that uses the calibredb
> executable instead of parsing the SQLite database directly.  Combined
> with compat this should lower the minimum required Emacs version to 27.
> Are there any other things that would block calibre.el's inclusion in
> GNU ELPA?

I don't think so, but I have forgotten the details of the proposal.  You
have signed your FSF CA, right?  Also, could you give me the URL again?

Re: [ELPA] New package: calibre.el

[Eli Zaretskii]

> From: Philip Kaludercic <philipk@posteo.net>
> Cc: emacs-devel@gnu.org
> Date: Wed, 10 May 2023 06:36:33 +0000
> 
> You have signed your FSF CA, right?

Kjartan's assignment is on file, yes.

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 553 bytes --]


Philip Kaludercic <philipk@posteo.net> writes:

> I don't think so, but I have forgotten the details of the proposal.  You
> have signed your FSF CA, right?  Also, could you give me the URL again?

https://git.disroot.org/kjartanoli/calibre.el

The short summary is that calibre.el enables a user to interact with a
Calibre library from Emacs.

I presume the copyright headers should be updated to list the FSF as the
copyright holder?

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]

Re: [ELPA] New package: calibre.el

[Philip Kaludercic]

Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> I don't think so, but I have forgotten the details of the proposal.  You
>> have signed your FSF CA, right?  Also, could you give me the URL again?
>
> https://git.disroot.org/kjartanoli/calibre.el

$ git clone https://git.disroot.org/kjartanoli/calibre.el
Cloning into 'calibre.el'...
fatal: repository 'https://git.disroot.org/kjartanoli/calibre.el/' not found

Did something change since your last message.  Sorry for the delay, but
I just got around to packaging it now.

> The short summary is that calibre.el enables a user to interact with a
> Calibre library from Emacs.
>
> I presume the copyright headers should be updated to list the FSF as the
> copyright holder?

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 726 bytes --]


Philip Kaludercic <philipk@posteo.net> writes:

> $ git clone https://git.disroot.org/kjartanoli/calibre.el
> Cloning into 'calibre.el'...
> fatal: repository 'https://git.disroot.org/kjartanoli/calibre.el/' not found
>
> Did something change since your last message.  Sorry for the delay, but
> I just got around to packaging it now.

No worries about the delay.  No nothing has changed that I'm aware of,
and the command succeeds on my end.  I can push to some other git host
if you think that would solve it.  Should I push a commit changing the
copyright headers to list the FSF as the copyright holder?

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]

Re: [ELPA] New package: calibre.el

[Philip Kaludercic]

Kjartan Óli Águstsson <kjartanoli@outlook.com> writes:

> Philip Kaludercic <philipk@posteo.net> writes:
>
>> $ git clone https://git.disroot.org/kjartanoli/calibre.el
>> Cloning into 'calibre.el'...
>> fatal: repository 'https://git.disroot.org/kjartanoli/calibre.el/' not found
>>
>> Did something change since your last message.  Sorry for the delay, but
>> I just got around to packaging it now.
>
> No worries about the delay.  No nothing has changed that I'm aware of,
> and the command succeeds on my end.  I can push to some other git host
> if you think that would solve it.  

This might have been a temporary issue, I can clone it now.  So unless
you have any ideas what the issue was, or if there is reason to suspect
it might occur again, then we can leave it as it is.

>                                    Should I push a commit changing the
> copyright headers to list the FSF as the copyright holder?

Yes, along with a commit that would update the Version header.

-- 
Philip Kaludercic

Re: [ELPA] New package: calibre.el

[Kjartan Óli Águstsson]

[-- Attachment #1: Type: text/plain, Size: 819 bytes --]


Philip Kaludercic <philipk@posteo.net> writes:

>> No worries about the delay.  No nothing has changed that I'm aware of,
>> and the command succeeds on my end.  I can push to some other git host
>> if you think that would solve it.  
>
> This might have been a temporary issue, I can clone it now.  So unless
> you have any ideas what the issue was, or if there is reason to suspect
> it might occur again, then we can leave it as it is.

Then I'll leave it for now.

>>                                    Should I push a commit changing the
>> copyright headers to list the FSF as the copyright holder?
>
> Yes, along with a commit that would update the Version header.

I've just pushed that.

-- 
Kjartan Oli Agustsson
GPG Key fingerprint: 4801 0D71 49C0 1DD6 E5FD  6AC9 D757 2FE3 605E E6B0

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 691 bytes --]