naming package as a library or tool

[Parag Nemade]

Hi,
   Sometimes I get confused how to handle naming of a package where
package itself provides a nodejs or python library and wrapper/tool to
use that library.
   We have guidelines where it says if source is library from npmjs or
pypi then we should prefix package with nodejs or python but how to
name when source contains both?
   What gets precedence? name them with prefixes or just by tool name
or library name?

Regards,
Parag.

[Dominik 'Rathann' Mierzejewski]

On Tuesday, 18 August 2015 at 09:52, Parag Nemade wrote:
>  Hi,
>     Sometimes I get confused how to handle naming of a package where
>  package itself provides a nodejs or python library and wrapper/tool to
>  use that library.
>     We have guidelines where it says if source is library from npmjs or
>  pypi then we should prefix package with nodejs or python but how to
>  name when source contains both?
>     What gets precedence? name them with prefixes or just by tool name
>  or library name? 
I'm assuming you're split between python-foo and nodejs-foo, so how
about naming the main package foo (it doesn't have to have any files,
mind you) and creating two subpackages: python-foo and nodejs-foo out
of it?

Regards,
Dominik
-- 
Fedora http://fedoraproject.org/wiki/User:Rathann
RPMFusion http://rpmfusion.org
"Faith manages."
        -- Delenn to Lennier in Babylon 5:"Confessions and Lamentations"

[Parag Nemade]

Hi,

On Tue, Aug 18, 2015 at 6:43 PM, Dominik 'Rathann' Mierzejewski
<dominik(a)greysector.net&gt; wrote:
>  On Tuesday, 18 August 2015 at 09:52, Parag Nemade wrote:
> > Hi,
> >    Sometimes I get confused how to handle naming of a package where
> > package itself provides a nodejs or python library and wrapper/tool to
> > use that library.
> >    We have guidelines where it says if source is library from npmjs or
> > pypi then we should prefix package with nodejs or python but how to
> > name when source contains both?
> >    What gets precedence? name them with prefixes or just by tool name
> > or library name?
>
>  I'm assuming you're split between python-foo and nodejs-foo, so how
>  about naming the main package foo (it doesn't have to have any files,
>  mind you) and creating two subpackages: python-foo and nodejs-foo out
>  of it?
>  
I think I was not clear in my initial email. I actually combined
nodejs and python thing.

Recently I approved a elasticdump[1] package review where I just
suggested nodejs's first naming rule[2] to follow which will make it
nodejs-elasticsearch but submitter wanted to follow nodejs naming
guidelines second rule that says use tool name as package name. I was
fine with that so I approved but then someone offline discussed with
me same for python packaging. So I need some guidance here.

Regards,
Parag.

[1] https://bugzilla.redhat.com/show_bug.cgi?id=1231564
[2] https://fedoraproject.org/wiki/Packaging:Node.js#Naming_Guidelines

[Haïkel]

2015-08-18 15:13 GMT+02:00 Dominik 'Rathann' Mierzejewski
<dominik(a)greysector.net&gt;:
>  On Tuesday, 18 August 2015 at 09:52, Parag Nemade wrote:
> > Hi,
> >    Sometimes I get confused how to handle naming of a package where
> > package itself provides a nodejs or python library and wrapper/tool to
> > use that library.
> >    We have guidelines where it says if source is library from npmjs or
> > pypi then we should prefix package with nodejs or python but how to
> > name when source contains both?
> >    What gets precedence? name them with prefixes or just by tool name
> > or library name?
>
>  I'm assuming you're split between python-foo and nodejs-foo, so how
>  about naming the main package foo (it doesn't have to have any files,
>  mind you) and creating two subpackages: python-foo and nodejs-foo out
>  of it?
>
>  Regards,
>  Dominik 
One could also leverage provides when splitting subpackages is not worth it.

ie: foobar provides a command-line (primary) and python2/python3 modules
=> foobar provides python-foobar and python2-foobar
=> python3-foobar (python3 variant)


>  --
>  Fedora http://fedoraproject.org/wiki/User:Rathann
>  RPMFusion http://rpmfusion.org
>  "Faith manages."
>          -- Delenn to Lennier in Babylon 5:"Confessions and Lamentations"
>  --
>  packaging mailing list
>  packaging(a)lists.fedoraproject.org
>  https://admin.fedoraproject.org/mailman/listinfo/packaging

[Matthew Miller]

On Tue, Aug 18, 2015 at 01:22:59PM +0530, Parag Nemade wrote:
>     Sometimes I get confused how to handle naming of a package where
>  package itself provides a nodejs or python library and wrapper/tool to
>  use that library.
>     We have guidelines where it says if source is library from npmjs or
>  pypi then we should prefix package with nodejs or python but how to
>  name when source contains both?
>     What gets precedence? name them with prefixes or just by tool name
>  or library name? 
Subpackages are definitely the answer here. There are still several
rational options. If the tool is primary, making the main package be
the upstream name ("foobar") makes sense, with subpackage for the
library ("python3-foobar", "foobar-libs"). If the library is primary,
though, you might want to go for "libfoobar" and "libfoobar-tools".


-- 
Matthew Miller
<mattdm(a)fedoraproject.org&gt;
Fedora Project Leader

[Parag Nemade]

Hi,

On Wed, Aug 19, 2015 at 12:29 AM, Matthew Miller
<mattdm(a)fedoraproject.org&gt; wrote:
>  On Tue, Aug 18, 2015 at 01:22:59PM +0530, Parag Nemade wrote:
> >    Sometimes I get confused how to handle naming of a package where
> > package itself provides a nodejs or python library and wrapper/tool to
> > use that library.
> >    We have guidelines where it says if source is library from npmjs or
> > pypi then we should prefix package with nodejs or python but how to
> > name when source contains both?
> >    What gets precedence? name them with prefixes or just by tool name
> > or library name?
>
>  Subpackages are definitely the answer here. There are still several
>  rational options. If the tool is primary, making the main package be
>  the upstream name ("foobar") makes sense, with subpackage for the
>  library ("python3-foobar", "foobar-libs"). If the library is
> primary,
>  though, you might want to go for "libfoobar" and "libfoobar-tools".
Thanks. I have too followed same thing for some of my packages
recently. Here what I want is, is this written somewhere? Just to give
reference to package submitter if he want some official source during
package review.

I can't find such explanation in python packaging guidelines wiki page
and also not in
https://fedoraproject.org/wiki/Packaging:NamingGuidelines#Addon_Packages_...
page.

Can some one if possible add this naming information there? Or do I
need to file a ticket on fpc for this?

Regards,
Parag.

[Toshio Kuratomi]

On Aug 19, 2015 8:10 PM, "Parag Nemade" <panemade(a)gmail.com&gt; wrote:
>  Hi,
>
>  On Wed, Aug 19, 2015 at 12:29 AM, Matthew Miller
>  <mattdm(a)fedoraproject.org&gt; wrote:
>  > On Tue, Aug 18, 2015 at 01:22:59PM +0530, Parag Nemade wrote:
>  >>    Sometimes I get confused how to handle naming of a package where
>  >> package itself provides a nodejs or python library and wrapper/tool to
>  >> use that library.
>  >>    We have guidelines where it says if source is library from npmjs or
>  >> pypi then we should prefix package with nodejs or python but how to
>  >> name when source contains both?
>  >>    What gets precedence? name them with prefixes or just by tool name
>  >> or library name?
>  >
>  > Subpackages are definitely the answer here. There are still several
>  > rational options. If the tool is primary, making the main package be
>  > the upstream name ("foobar") makes sense, with subpackage for the
>  > library ("python3-foobar", "foobar-libs"). If the library is
> primary,
>  > though, you might want to go for "libfoobar" and
> "libfoobar-tools".
>
>  Thanks. I have too followed same thing for some of my packages
>  recently. Here what I want is, is this written somewhere? Just to give
>  reference to package submitter if he want some official source during
>  package review.
>
>  I can't find such explanation in python packaging guidelines wiki page
>  and also not in
https://fedoraproject.org/wiki/Packaging:NamingGuidelines#Addon_Packages_...
>  page.
>
>  Can some one if possible add this naming information there? Or do I
>  need to file a ticket on fpc for this?
>  
In current guidelines, libraries and applications are allowed to mix in the
same (sub)package.  For c packages, we've slowly gotten away from this
practice due to multi lib.  But no such technical reason for demanding
packages split binary and library exists for python, ruby, Perl, nodejs,
etc.

It's (a little) more work to split every package that ships a small script
along with its library.  So traditionally we don't make that demand..  if
the application is important enough and the library is just implementation
detail then we have the package ship everything under a non-prefixed name.
If the library is most important and the script is along the lines of a
usable example of what you can do with the library then we use the python-
prefix.  We don't really talk about the case where application and library
are of equal value but packagers are expected to use good judgement and
probably should use subpackages to address the situation.

There is a lot of grey area between these three points of interest.  I
wouldn't be opposed to the guidelines being updated to either eliminate
some of them  (for instance, libraries and "binaries" must always be in
separate subordinates) or for a more comprehensive description of when to
use each style of packaging.  I'd only ask that this be applied to all
packages, not just python and nodejs.  It really is a style issue that
should apply to similar packages in all languages.

-Toshio

[Toshio Kuratomi]

This ticket touches on some of the same areas being discussed here:
https://lists.fedoraproject.org/pipermail/packaging/2015-August/010930.html

-Toshio