Bug 1433767 - Review Request: ptpython - Python REPL build on top of prompt_toolkit
Summary: Review Request: ptpython - Python REPL build on top of prompt_toolkit
Keywords:
Status: CLOSED NEXTRELEASE
Alias: None
Product: Fedora
Classification: Fedora
Component: Package Review
Version: rawhide
Hardware: All
OS: Linux
medium
medium
Target Milestone: ---
Assignee: Adam Miller
QA Contact: Fedora Extras Quality Assurance
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2017-03-19 23:03 UTC by Carl George
Modified: 2017-03-22 19:11 UTC (History)
2 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-03-22 19:11:24 UTC
Type: ---
Embargoed:
admiller: fedora-review+


Attachments (Terms of Use)

Description Carl George 2017-03-19 23:03:16 UTC
Spec URL: https://carlgeorge.fedorapeople.org/ptpython/ptpython.spec
SRPM URL: https://carlgeorge.fedorapeople.org/ptpython/ptpython-0.36-1.fc25.src.rpm
COPR: https://copr.fedorainfracloud.org/coprs/carlgeorge/ptpython/
Description: Ptpython is an advanced Python REPL built on top of the prompt_toolkit library.  It features syntax highlighting, multiline editing (the up arrow works), autocompletion, mouse support, support for color schemes, support for bracketed paste, both Vi and Emacs key bindings, support for double width (Chinese) characters, and many other things.
Fedora Account System Username: carlgeorge

I plan to maintain this in both Fedora and EPEL6/7 eventually, but I need to get python-jedi into EPEL first.  For now just treat this as a Fedora-only request (f25/f26/master).

$ rpmlint \
> SPECS/ptpython.spec \
> SRPMS/ptpython-0.36-1.fc25.src.rpm \
> RPMS/ptpython2-0.36-1.fc25.noarch.rpm \
> RPMS/ptpython3-0.36-1.fc25.noarch.rpm 
ptpython.src: W: spelling-error %description -l en_US multiline -> multilingual
ptpython.src: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython2.noarch: W: spelling-error %description -l en_US Ptpython -> Pt python, Pt-python, Python
ptpython2.noarch: W: spelling-error %description -l en_US multiline -> multilingual
ptpython2.noarch: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython2.noarch: W: no-manual-page-for-binary ptpython
ptpython2.noarch: W: no-manual-page-for-binary ptpython2
ptpython2.noarch: W: no-manual-page-for-binary ptpython2.7
ptpython2.noarch: W: no-manual-page-for-binary ptipython
ptpython2.noarch: W: no-manual-page-for-binary ptipython2
ptpython2.noarch: W: no-manual-page-for-binary ptipython2.7
ptpython3.noarch: W: spelling-error %description -l en_US Ptpython -> Pt python, Pt-python, Python
ptpython3.noarch: W: spelling-error %description -l en_US multiline -> multilingual
ptpython3.noarch: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython3.noarch: W: no-manual-page-for-binary ptpython3
ptpython3.noarch: W: no-manual-page-for-binary ptpython3.5
ptpython3.noarch: W: no-manual-page-for-binary ptipython3
ptpython3.noarch: W: no-manual-page-for-binary ptipython3.5
3 packages and 1 specfiles checked; 0 errors, 18 warnings.

I believe the spelling warnings are false positives.  Upstream doesn't provide manpages.  For reference, two other Python REPLs in Fedora (ipython and bpython) don't have man pages either.

I also want to address my thought process behind the package naming.  Since this is primarily used as a CLI tool, not as an importable module, I didn't think the naming it "python{,2,3}-ptpython" was the best choice.  Instead, I went with a naming scheme that felt a bit more natural.

SRPM: ptpython
RPM: ptpython2 (provides python2-ptpython, python-ptpython, and ptpython)
RPM: ptpython3 (provides python3-ptpython)

Comment 1 Adam Miller 2017-03-22 13:57:39 UTC
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: "BSD (3 clause)", "Unknown or generated". 35 files have unknown
     license. Detailed output of licensecheck in
     /home/admiller/reviews/1433767-ptpython/licensecheck.txt
[x]: License file installed when any subpackage combination is installed.
[x]: Package contains no bundled libraries without FPC exception.
[x]: Changelog in prescribed format.
[x]: Sources contain only permissible code or content.
[x]: 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 40960 bytes in 4 files.
[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: 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 %license.
[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 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]: Dist tag is present.
[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 does not use a name that already exists.
[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.
[ ]: 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]: Fully versioned dependency in subpackages if applicable.
     Note: No Requires: %{name}%{?_isa} = %{version}-%{release} in
     ptpython2 , ptpython3
[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.
[-]: %check is present and all tests pass.
[x]: Packages should try to preserve timestamps of original installed
     files.
[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]: No file requires outside of /etc, /bin, /sbin, /usr/bin, /usr/sbin.
[x]: Packager, Vendor, PreReq, Copyright tags should not be in spec file
[x]: Sources can be downloaded from URI in Source: tag
[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: ptpython2-0.36-1.fc25.noarch.rpm
          ptpython3-0.36-1.fc25.noarch.rpm
          ptpython-0.36-1.fc25.src.rpm
ptpython2.noarch: W: spelling-error %description -l en_US Ptpython -> Pt python, Pt-python, Python
ptpython2.noarch: W: spelling-error %description -l en_US multiline -> multilingual
ptpython2.noarch: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython2.noarch: W: no-manual-page-for-binary ptipython2.7
ptpython2.noarch: W: no-manual-page-for-binary ptipython2
ptpython2.noarch: W: no-manual-page-for-binary ptpython2
ptpython2.noarch: W: no-manual-page-for-binary ptipython
ptpython2.noarch: W: no-manual-page-for-binary ptpython
ptpython2.noarch: W: no-manual-page-for-binary ptpython2.7
ptpython3.noarch: W: spelling-error %description -l en_US Ptpython -> Pt python, Pt-python, Python
ptpython3.noarch: W: spelling-error %description -l en_US multiline -> multilingual
ptpython3.noarch: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython3.noarch: W: no-manual-page-for-binary ptipython3
ptpython3.noarch: W: no-manual-page-for-binary ptpython3.5
ptpython3.noarch: W: no-manual-page-for-binary ptipython3.5
ptpython3.noarch: W: no-manual-page-for-binary ptpython3
ptpython.src: W: spelling-error %description -l en_US multiline -> multilingual
ptpython.src: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
3 packages and 0 specfiles checked; 0 errors, 18 warnings.




Rpmlint (installed packages)
----------------------------
ptpython3.noarch: W: spelling-error %description -l en_US Ptpython -> Pt python, Pt-python, Python
ptpython3.noarch: W: spelling-error %description -l en_US multiline -> multilingual
ptpython3.noarch: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython3.noarch: W: no-manual-page-for-binary ptipython3
ptpython3.noarch: W: no-manual-page-for-binary ptpython3
ptpython3.noarch: W: no-manual-page-for-binary ptpython3.5
ptpython3.noarch: W: no-manual-page-for-binary ptipython3.5
ptpython2.noarch: W: spelling-error %description -l en_US Ptpython -> Pt python, Pt-python, Python
ptpython2.noarch: W: spelling-error %description -l en_US multiline -> multilingual
ptpython2.noarch: W: spelling-error %description -l en_US autocompletion -> auto completion, auto-completion, completion
ptpython2.noarch: W: no-manual-page-for-binary ptpython2.7
ptpython2.noarch: W: no-manual-page-for-binary ptipython
ptpython2.noarch: W: no-manual-page-for-binary ptpython2
ptpython2.noarch: W: no-manual-page-for-binary ptpython
ptpython2.noarch: W: no-manual-page-for-binary ptipython2
ptpython2.noarch: W: no-manual-page-for-binary ptipython2.7
2 packages and 0 specfiles checked; 0 errors, 16 warnings.



Requires
--------
ptpython3 (rpmlib, GLIBC filtered):
    /usr/bin/python3
    python(abi)
    python3-docopt
    python3-jedi
    python3-prompt_toolkit
    python3-pygments

ptpython2 (rpmlib, GLIBC filtered):
    /usr/bin/python2
    python(abi)
    python-jedi
    python-pygments
    python2-docopt
    python2-prompt_toolkit



Provides
--------
ptpython3:
    ptpython3
    python3-ptpython
    python3.5dist(ptpython)
    python3dist(ptpython)

ptpython2:
    ptpython
    ptpython2
    python-ptpython
    python2-ptpython
    python2.7dist(ptpython)
    python2dist(ptpython)



Source checksums
----------------
https://files.pythonhosted.org/packages/source/p/ptpython/ptpython-0.36.tar.gz :
  CHECKSUM(SHA256) this package     : a84b6398962a92e07a33891c4eae821173fb4c03a4d403b1b099edf370c86d53
  CHECKSUM(SHA256) upstream package : a84b6398962a92e07a33891c4eae821173fb4c03a4d403b1b099edf370c86d53


Generated by fedora-review 0.6.1 (f03e4e7) last change: 2016-05-02
Command line :/usr/bin/fedora-review -b 1433767
Buildroot used: fedora-25-x86_64
Active plugins: Python, Generic, Shell-api
Disabled plugins: Java, C/C++, fonts, SugarActivity, Ocaml, Perl, Haskell, R, PHP
Disabled flags: EXARCH, DISTTAG, EPEL5, BATCH, EPEL6



APPROVED

Comment 2 Gwyn Ciesla 2017-03-22 15:29:41 UTC
Package request has been approved: https://admin.fedoraproject.org/pkgdb/package/rpms/ptpython

Comment 3 Carl George 2017-03-22 19:11:24 UTC
Thanks Adam and Gwyn!


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