Bug 1071581 - Review Request: python-wikitools - Python package for interacting with a MediaWiki wiki
Summary: Review Request: python-wikitools - Python package for interacting with a Medi...
Keywords:
Status: CLOSED RAWHIDE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Mukundan Ragavan
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2014-03-01 23:06 UTC by Honza Horak
Modified: 2014-04-30 07:59 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2014-04-30 07:59:48 UTC
Type: ---
Embargoed:
nonamedotc: fedora-review+
gwync: fedora-cvs+


Attachments (Terms of Use)

Description Honza Horak 2014-03-01 23:06:38 UTC
Spec URL: http://hhorak.fedorapeople.org/python-wikitools/python-wikitools.spec
SRPM URL: http://hhorak.fedorapeople.org/python-wikitools/python-wikitools-1.1.1-2.src.rpm
Description: A Python package for interacting with a MediaWiki wiki using the MediaWiki API.
Designed for MediaWiki version 1.16 and higher, should work on 1.13, older
versions may have bugs.
The edit-API must be enabled on the site to use editing features.
Fedora Account System Username: hhorak

Comment 1 Mukundan Ragavan 2014-03-01 23:25:20 UTC
I will take it.

Comment 2 Mukundan Ragavan 2014-03-03 20:58:44 UTC
Few issues from looking at the spec files.

* BuildRequires: python2-devel (or python3-devel) should be present.

https://fedoraproject.org/wiki/Packaging:Python#BuildRequires

* Avoid INSTALLED_FILES. This, as per my understanding, causes permissions problems.

Quoting from https://fedoraproject.org/wiki/Packaging:Python - 

"Warning (medium size).png
Avoid INSTALLED_FILES
python's distutils has an INSTALLED_FILES feature that lists which files are installed when you run python setup.py install. Do not use it for packaging as that will not list the directories which need to be specified in the %files section as well. Using globs in the %files section is simpler and safer."

* BUILDROOT tag is not needed.
https://fedoraproject.org/wiki/Packaging:Guidelines?rd=Packaging/Guidelines#BuildRoot_tag

* Release: 2%{?dist} should be present. Dist tag is missing. While not strictly needed, please consider including the tag.

* %clean is present. According to guidelines, %clean should not be present.
https://fedoraproject.org/wiki/Packaging:Guidelines?rd=Packaging/Guidelines#.25clean

Of course, all this is from the perspective of Fedora (as mentioned in the spec file). Some of the comments above are not applicable if used in the context of EL5.

Comment 3 Honza Horak 2014-04-15 11:20:27 UTC
Mukundan, thanks for the feedback and this is a bit late fixed version of the spec/srpm:
http://hhorak.fedorapeople.org/python-wikitools/python-wikitools-1.1.1-3.fc20.src.rpm
http://hhorak.fedorapeople.org/python-wikitools/python-wikitools.spec

Comment 4 Mukundan Ragavan 2014-04-28 23:03:24 UTC
Hi Honza, here is a more detailed review. There are couple of issues. Please see below.


Package Review
==============

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



===== 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:
     "GPL (v3 or later)", "Unknown or generated". 2 files have unknown
     license. Detailed output of licensecheck in
     /home/mukundan/personal/pkgs/reviews/1071581-python-
     wikitools/licensecheck.txt

---> No problems.


GPL (v3 or later)
-----------------
wikitools-1.1.1/wikitools/api.py
wikitools-1.1.1/wikitools/category.py
wikitools-1.1.1/wikitools/page.py
wikitools-1.1.1/wikitools/pagelist.py
wikitools-1.1.1/wikitools/user.py
wikitools-1.1.1/wikitools/wiki.py
wikitools-1.1.1/wikitools/wikifile.py

Unknown or generated
--------------------
wikitools-1.1.1/setup.py
wikitools-1.1.1/wikitools/__init__.py

[!]: Package requires other packages for directories it uses.
     Note: No known owner of /usr/lib/python2.7/site-packages/wikitools
[!]: Package must own all directories that it creates.
     Note: Directories without known owners: /usr/lib/python2.7/site-
     packages/wikitools

---> please add the appropriate directory under %files.

[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.
[-]: Large documentation must go in a -doc subpackage. Large could be size
     (~1MB) or number of files.
     Note: Documentation size is 51200 bytes in 3 files.
[!]: 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: There are rpmlint messages (see attachment).
[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 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 uses either %{buildroot} or $RPM_BUILD_ROOT
[x]: Package does not run rm -rf %{buildroot} (or $RPM_BUILD_ROOT) at the
     beginning of %install.
[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]: 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]: Package contains BR: python2-devel or python3-devel
[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).
[x]: Package functions as described.
[x]: Latest version is packaged.
[x]: Package does not include license text files separate from upstream.
[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.
[x]: %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]: Sources can be downloaded from URI in Source: tag
[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 (not strictly required in GL).
[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: There are rpmlint messages (see attachment).
[x]: Spec file according to URL is the same as in SRPM.


Rpmlint
-------
Checking: python-wikitools-1.1.1-3.fc21.noarch.rpm
          python-wikitools-1.1.1-3.fc21.src.rpm
python-wikitools.noarch: W: spelling-error %description -l en_US http -> HTTP
python-wikitools.noarch: W: spelling-error %description -l en_US google -> Google, goggle, googly
python-wikitools.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-wikitools/CHANGELOG

https://fedoraproject.org/wiki/Common_Rpmlint_issues#wrong-file-end-of-line-encoding

python-wikitools.src: W: spelling-error %description -l en_US http -> HTTP
python-wikitools.src: W: spelling-error %description -l en_US google -> Google, goggle, googly
2 packages and 0 specfiles checked; 0 errors, 5 warnings.




Rpmlint (installed packages)
----------------------------
# rpmlint python-wikitools
python-wikitools.noarch: W: spelling-error %description -l en_US http -> HTTP
python-wikitools.noarch: W: spelling-error %description -l en_US google -> Google, goggle, googly
python-wikitools.noarch: W: wrong-file-end-of-line-encoding /usr/share/doc/python-wikitools/CHANGELOG
1 packages and 0 specfiles checked; 0 errors, 3 warnings.
# echo 'rpmlint-done:'



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



Provides
--------
python-wikitools:
    python-wikitools



Source checksums
----------------
http://python-wikitools.googlecode.com/files/wikitools-1.1.1.tar.gz :
  CHECKSUM(SHA256) this package     : aef7fb27d408fc8d4162c311eaf3e85296ad2ab654a94308d65ef8d50e72e2e4
  CHECKSUM(SHA256) upstream package : aef7fb27d408fc8d4162c311eaf3e85296ad2ab654a94308d65ef8d50e72e2e4


Generated by fedora-review 0.5.1 (bb9bf27) last change: 2013-12-13
Command line :/usr/bin/fedora-review -m fedora-rawhide-x86_64 -b 1071581
Buildroot used: fedora-rawhide-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: Java, C/C++, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP, Ruby
Disabled flags: EXARCH, EPEL5, BATCH, DISTTAG

Comment 5 Honza Horak 2014-04-29 11:38:59 UTC
(In reply to Mukundan Ragavan from comment #4)
> [!]: Package requires other packages for directories it uses.
>      Note: No known owner of /usr/lib/python2.7/site-packages/wikitools
> [!]: Package must own all directories that it creates.
>      Note: Directories without known owners: /usr/lib/python2.7/site-
>      packages/wikitools
> 
> ---> please add the appropriate directory under %files.

Mukundan, thanks for the feedback again. So there was only one thing to fix -- the directory ownership, right?

The fixed spec/srpm are here:
http://hhorak.fedorapeople.org/python-wikitools/python-wikitools-1.1.1-4.fc20.src.rpm
http://hhorak.fedorapeople.org/python-wikitools/python-wikitools.spec

Comment 6 Mukundan Ragavan 2014-04-29 12:52:53 UTC
Yup. All good now! :)

Package approved.

Comment 7 Honza Horak 2014-04-29 12:57:43 UTC
(In reply to Mukundan Ragavan from comment #6)
> Yup. All good now! :)
> 
> Package approved.

Thanks again.

Comment 8 Honza Horak 2014-04-29 13:02:45 UTC
New Package SCM Request
=======================
Package Name: python-wikitools
Short Description: Python package for interacting with a MediaWiki wiki
Owners: hhorak
Branches: f19 f20 el6 epel7
InitialCC:

Comment 9 Gwyn Ciesla 2014-04-29 14:18:35 UTC
Git done (by process-git-requests).


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