Bug 923035 (pybrain) - Review Request: pybrain - The python machine learning library
Summary: Review Request: pybrain - The python machine learning library
Keywords:
Status: CLOSED WONTFIX
Alias: pybrain
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Michael S.
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On: python-rlglue pycdf pyode
Blocks:
TreeView+ depends on / blocked
 
Reported: 2013-03-19 03:54 UTC by Ankur Sinha (FranciscoD)
Modified: 2017-12-17 14:39 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-12-17 14:39:25 UTC
Type: ---
Embargoed:
misc: fedora-review?


Attachments (Terms of Use)

Description Ankur Sinha (FranciscoD) 2013-03-19 03:54:43 UTC
Spec URL: http://ankursinha.fedorapeople.org/pybrain/pybrain.spec
SRPM URL: http://ankursinha.fedorapeople.org/pybrain/pybrain-0.3.1-1.fc18.src.rpm

Description: 
PyBrain is a modular Machine Learning Library for Python. Its goal is to offer
flexible, easy-to-use yet still powerful algorithms for Machine Learning Tasks
and a variety of predefined environments to test and compare your algorithms.

PyBrain is short for Python-Based Reinforcement Learning, Artificial
Intelligence and Neural Network Library. In fact, we came up with the name
first and later reverse-engineered this quite descriptive "Backronym". 

Fedora Account System Username: ankursinha


rpmlint info:
[ankur@dhcppc1  SRPMS]$ rpmlint ../SPECS/pybrain.spec ./pybrain-0.3.1-1.fc18.src.rpm /var/lib/mock/fedora-18-x86_64/result/*.rpm
../SPECS/pybrain.spec:13: W: macro-in-comment %{name}
../SPECS/pybrain.spec:13: W: macro-in-comment %{name}
../SPECS/pybrain.spec:13: W: macro-in-comment %{version}
../SPECS/pybrain.spec: W: invalid-url Source0: pybrain-0.3.1.tar.gz
pybrain.src:13: W: macro-in-comment %{name}
pybrain.src:13: W: macro-in-comment %{name}
pybrain.src:13: W: macro-in-comment %{version}
pybrain.src: W: invalid-url Source0: pybrain-0.3.1.tar.gz
pybrain.src:13: W: macro-in-comment %{name}
pybrain.src:13: W: macro-in-comment %{name}
pybrain.src:13: W: macro-in-comment %{version}
pybrain.src: W: invalid-url Source0: pybrain-0.3.1.tar.gz
3 packages and 1 specfiles checked; 0 errors, 12 warnings.
[ankur@dhcppc1  SRPMS]$

Comment 1 Michael S. 2013-03-24 14:10:26 UTC
Package Review
==============

Key:
[x] = Pass, [!] = Fail, [-] = Not applicable, [?] = Not evaluated
[ ] = Manual review needed


Issues:
=======
- Package should contains BR: python2-devel or python3-devel
  See: http://fedoraproject.org/wiki/Packaging:Python#BuildRequires
- Large documentation must go in a -doc subpackage.
  Note: Documentation size is 2078720 bytes in 189 files.
  See: http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation
- no need for macro python_sitelib as they are in rpm already

- no need for CFLAGS in %build

- since the package come from github, I think there is some guideline
on how to download https://fedoraproject.org/wiki/Packaging:SourceURL#Github
I think clearer instruction would help

- no need for rm -Rf RPM_BUILD_ROOT in %install 

- you can use sed -i in %install 

- since there is tests, they should be run in %check

- while I am not sure of everything, it seems that some packages are needed
for some features :
pylab 
numpy
mlabwrap
OpenGL.GLUT

===== MUST items =====

Generic:
[x]: Package is licensed with an open-source compatible license and meets
     other legal requirements as defined in the legal section of Packaging
     Guidelines.
[x]: License field in the package spec file matches the actual license.
     Note: Checking patched sources after %prep for licenses. Licenses found:
     "Unknown or generated". 1 files have unknown license. Detailed output of
     licensecheck in
     /home/misc/checkout/git/FedoraReview/923035-pybrain/licensecheck.txt
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[-]: Package contains desktop file if it is a GUI application.
[-]: Development files must be in a -devel package
[x]: Package uses nothing in %doc for runtime.
[x]: Package consistently uses macros (instead of hard-coded directory names).
[x]: Package is named according to the Package Naming Guidelines.
[x]: Package does not generate any conflict.
[x]: Package obeys FHS, except libexecdir and /usr/target.
[-]: If the package is a rename of another package, proper Obsoletes and
     Provides are present.
[x]: Requires correct, justified where necessary.
[x]: Spec file is legible and written in American English.
[-]: Package contains systemd file(s) if in need.
[x]: Package is not known to require an ExcludeArch tag.
[x]: Package complies to the Packaging Guidelines
[x]: Package successfully compiles and builds into binary rpms on at least one
     supported primary architecture.
[x]: Package installs properly.
[x]: Rpmlint is run on all rpms the build produces.
     Note: No rpmlint messages.
[x]: If (and only if) the source package includes the text of the license(s)
     in its own file, then that file, containing the text of the license(s)
     for the package is included in %doc.
[x]: Package requires other packages for directories it uses.
[x]: Package must own all directories that it creates.
[x]: Package does not own files or directories owned by other packages.
[x]: All build dependencies are listed in BuildRequires, except for any that
     are listed in the exceptions section of Packaging Guidelines.
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[x]: Each %files section contains %defattr if rpm < 4.4
[x]: Macros in Summary, %description expandable at SRPM build time.
[x]: Package does not contain duplicates in %files.
[x]: Permissions on files are set properly.
[x]: Fully versioned dependency in subpackages, if present.
[x]: Package use %makeinstall only when make install' ' DESTDIR=... doesn't
     work.
[x]: Package is named using only allowed ASCII characters.
[x]: Package do not use a name that already exist
[x]: Package is not relocatable.
[x]: Sources used to build the package match the upstream source, as provided
     in the spec URL.
[x]: Spec file name must match the spec package %{name}, in the format
     %{name}.spec.
[x]: File names are valid UTF-8.
[x]: Packages must not store files under /srv, /opt or /usr/local

Python:
[x]: Python eggs must not download any dependencies during the build process.
[x]: A package which is used by another package via an egg interface should
     provide egg info.
[x]: Package meets the Packaging Guidelines::Python
[x]: Binary eggs must be removed in %prep

===== SHOULD items =====

Generic:
[-]: If the source package does not include license text(s) as a separate file
     from upstream, the packager SHOULD query upstream to include it.
[x]: Final provides and requires are sane (see attachments).
[ ]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[!]: SourceX tarball generation or download is documented.
     Note: Package contains tarball without URL, check comments
[x]: Description and summary sections in the package spec file contains
     translations for supported Non-English languages, if available.
[x]: Package should compile and build into binary rpms on all supported
     architectures.
[!]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed files.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Reviewer should test that the package builds in mock.
[x]: Buildroot is not present
[x]: Package has no %clean section with rm -rf %{buildroot} (or
     $RPM_BUILD_ROOT)
[x]: Dist tag is present.
[x]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: SourceX is a working URL.
[x]: Spec use %global instead of %define unless justified.

===== EXTRA items =====

Generic:
[x]: Rpmlint is run on all installed packages.
     Note: No rpmlint messages.
[x]: Large data in /usr/share should live in a noarch subpackage if package is
     arched.
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: pybrain-0.3.1-1.fc18.noarch.rpm
1 packages and 0 specfiles checked; 0 errors, 0 warnings.




Rpmlint (installed packages)
----------------------------
# rpmlint pybrain
1 packages and 0 specfiles checked; 0 errors, 0 warnings.
# echo 'rpmlint-done:'



Requires
--------
pybrain (rpmlib, GLIBC filtered):
    python(abi)



Provides
--------
pybrain:
    pybrain



Generated by fedora-review 0.4.0 (cf29f98) last change: 2013-02-08
Buildroot used: fedora-18-x86_64
Command line :./try-fedora-review -b 923035

Comment 2 Ankur Sinha (FranciscoD) 2013-03-25 22:53:01 UTC
Hi Michael,

There are a few optional deps here:

https://github.com/pybrain/pybrain/wiki/Dependencies

While they appear to be runtime, I'll package them up so that pybrain can be better utilised. 

Thanks,
Warm regards,
Ankur

Comment 3 Ankur Sinha (FranciscoD) 2013-03-26 05:48:09 UTC
Hi Michael,

I've updated the spec/srpm with the requested changes:

* Mon Mar 25 2013 Ankur Sinha <ankursinha AT fedoraproject DOT org> 0.3.1-2
- Correct issues in rhbz# 923035
- run tests
- doc separate package
- add requires
- remove arch specific spec bits

Some of the requires aren't in Fedora. I'm packaging them up too. They're runtime requires which are listed as optional on the project wiki page. I've added them to the spec and will not build until they're all in the repos. Adding blocker bugs too.

SPEC/SRPM:

http://ankursinha.fedorapeople.org/pybrain/pybrain.spec

http://ankursinha.fedorapeople.org/pybrain/pybrain-0.3.1-2.fc20.src.rpm

Thanks, 
Warm regards,
Ankur

Comment 4 Mario Blättermann 2013-08-24 09:52:21 UTC
Requires:       python-imaging

Note, python-imaging is provided virtually by python-pillow since f19 [1]. Make sure it works with Pillow. In some cases small code modifications are needed [2].

[1] http://fedoraproject.org/wiki/Features/Pillow
[2] http://fedoraproject.org/wiki/Features/Pillow#How_To_Test

Comment 5 Ankur Sinha (FranciscoD) 2013-08-24 13:16:13 UTC
I'll update the spec for pillow when I submit a new spec next. Thanks.

Comment 6 Ankur Sinha (FranciscoD) 2013-08-25 00:30:32 UTC
Mario,

The run deps are only required for specific purposes as the wiki states here:

https://github.com/pybrain/pybrain/wiki/Dependencies

Can we proceed with this review and get this package done. The runtime deps are not blocks, they are only extra features. I can continue working on them later.

Thanks,
Ankur

Comment 7 Mario Blättermann 2013-08-25 11:54:03 UTC
(In reply to Ankur Sinha (FranciscoD) from comment #6) 
> The run deps are only required for specific purposes as the wiki states here:
> 
> https://github.com/pybrain/pybrain/wiki/Dependencies
>
I know about that. We speak about the following optional dependencies:

* LIBSVM - available
* RL-Glue - available
* ODE version 0.8 - available
* PyOde version 1.2 - available
* PIL (Python Imaging Library) - available as python-pillow, probably some code patches needed
* PyOpenGL version 3.0 - available
* tk/tkinter - available
* PyCDF - not available!
* SCons - available


> Can we proceed with this review and get this package done. The runtime deps
> are not blocks, they are only extra features. I can continue working on them
> later.

Especially referring to pycdf, we cannot ship a package with unresolvable runtime dependencies. You have to drop pycdf from the spec or comment in out for now. In general, such optional dependencies should be outsourced in subpackages wherever possible, with a useful description what the extra feature does, and the subpackage pulls the appropriate dependency. So we keep the requirements of the main package small and clean, and if someone doesn't need any of the extra features, he is not forced to install them. See also https://lists.fedoraproject.org/pipermail/packaging/2013-August/009454.html

Comment 8 Ankur Sinha (FranciscoD) 2014-02-09 09:10:05 UTC
Well, there's no documentation to suggest what optional dependency is required for what purpose. The docs specify the pyode is required for using ODEs and nothing else. Unfortunately, I'm not using this library for work any more so I don't have much of an incentive to chase this down. I cannot break it down into subpackages. If the current way of pulling in the optional deps isn't good enough, I'm afraid I'll have to drop the package :/

Thanks,
Warm regards,
Ankur


Note You need to log in before you can comment on or make changes to this bug.