Package Details: term-pdf 0.0.4.5-1

Git Clone URL: https://aur.archlinux.org/term-pdf.git (read-only, click to copy)
Package Base: term-pdf
Description: TermPDF Viewer is an open-source PDF file viewer designed to run in the terminal.
Upstream URL: https://github.com/felipealfonsog/TermPDFViewer
Keywords: console pdf terminal utility viewer
Licenses: MIT
Submitter: felipealfonsog
Maintainer: felipealfonsog
Last Packager: felipealfonsog
Votes: 2
Popularity: 1.01
First Submitted: 2023-08-10 10:15 (UTC)
Last Updated: 2024-03-03 04:18 (UTC)

Pinned Comments

felipealfonsog commented on 2023-09-04 08:16 (UTC) (edited on 2023-09-14 01:20 (UTC) by felipealfonsog)

@m040601 : Fundamentally, this project is unmistakably labeled as "experimental" in its README, even featuring a badge to highlight its nature. Are you perhaps overlooking these clear indicators? This extensive message harboring disrespectful critiques towards the project appears rather preposterous and frivolous. Due to the discourtesy and absurdity embedded in your words, I shall disregard the entirety of your message and any future communications. I shall initiate a formal report as a user on this platform.

GENERAL IMPORTANT NOTE:

Furthermore, for any other inquiries or issues that other users may encounter regarding the project, I kindly urge to any other user to approach them with respect and guide them to the project's GitHub issues page. Thank you.

Latest Comments

carlosal1015 commented on 2023-09-14 00:37 (UTC)

Hi Felipe, looks the PKGBUILD is not following https://wiki.archlinux.org/title/Python_package_guidelines

felipealfonsog commented on 2023-09-04 08:16 (UTC) (edited on 2023-09-14 01:20 (UTC) by felipealfonsog)

@m040601 : Fundamentally, this project is unmistakably labeled as "experimental" in its README, even featuring a badge to highlight its nature. Are you perhaps overlooking these clear indicators? This extensive message harboring disrespectful critiques towards the project appears rather preposterous and frivolous. Due to the discourtesy and absurdity embedded in your words, I shall disregard the entirety of your message and any future communications. I shall initiate a formal report as a user on this platform.

GENERAL IMPORTANT NOTE:

Furthermore, for any other inquiries or issues that other users may encounter regarding the project, I kindly urge to any other user to approach them with respect and guide them to the project's GitHub issues page. Thank you.

m040601 commented on 2023-09-03 19:18 (UTC) (edited on 2023-09-03 20:26 (UTC) by m040601)

Thanks for your work on the tool and maitaining this PKGBUILD.

Did you actually test if the PKGBUILD was working on your system ?

I cant get it to work on my system. Here is some feedback and tips to help you improve this PKGBUILD.

The installation seems to go fine but then,

$ term-pdf somefile.pdf

bash: /usr/bin/term-pdf: No such file or directory

$ term-pdf -h

bash: /usr/bin/term-pdf: No such file or directory

Uhhmmm ???

$ file /usr/bin/term-pdf

/usr/bin/term-pdf: ELF 64-bit LSB pie executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /home/linuxbrew/.linuxbrew/lib/ld.so, for GNU/Linux 3.2.0, BuildID[sha1]=9d4f73394de2b86467af91d397559e03af86145c, stripped

$ ls -lh /usr/bin/term-pdf

-rwxr-xr-x 1 root root 30M Sep  3 20:16 /usr/bin/term-pdf

$ pacman -Ql term-pdf

term-pdf /usr/
term-pdf /usr/bin/
term-pdf /usr/bin/term-pdf

In your PKGBUILD you have this

source=("https://github.com/felipealfonsog/TermPDFViewer/archive/refs/tags/v.${pkgver}.tar.gz")

On a "normal" AUR PKGBUILD, this tar.gz is supposed to be some "source" code archive hosted on github. But then on the github releases page, https://github.com/felipealfonsog/TermPDFViewer/releases/tag/v.0.0.2

You have

Assets 4

termpdf-linux 29 MB 2023-08-10T09:41:47Z
termpdf-macos 41.7 MB 2023-08-10T09:42:08Z

OK. These are precompiled binaries you release on github. Nice. Use them to make an Archlinux AUR PKGBUILD "termpdfviewer-bin". Mac packagers can do the same for their systems. No need to compile or "build" anything. Just trust that precompiled binary on github.

But then,

Source code (zip)
Source code (tar.gz) 

Which is a giant tar.gz archive, bigger that 100 Mega. It has a folder "dist" with binaries and everything and the kitchen sink inside.

$ file TermPDFViewer-v.0.0.2.tar.gz

TermPDFViewer-v.0.0.2.tar.gz: gzip compressed data, from Unix, original size modulo 2^32 119603200

$ ls -hl TermPDFViewer-v.0.0.2.tar.gz

-rw-r--r-- 1 a1 a1 113M Sep  3 20:28 TermPDFViewer-v.0.0.2.tar.gz

$ tree TermPDFViewer-v.0.0.2/

TermPDFViewer-v.0.0.2/
├── build
├── dist
│   ├── linux
│   │   └── termpdf-linux
│   └── macos
│       └── termpdf-macos
├── docs
│   ├── IMG_3810.JPG
│   └── IMG_3817.JPG
├── images
│   ├── linux
│   │   ├── sshot-termpdf-1.jpg
│   │   ├── sshot-termpdf-2.jpg
│   │   ├── sshot-termpdf-3.jpg
│   │   ├── sshot-termpdf-4.jpg
│   │   ├── sshot-termpdf-5.jpg
│   │   └── sshot-termpdf-6.jpg
│   └── mac
│       ├── sshot-termpdf-1.png
│       ├── sshot-termpdf-2.png
│       ├── sshot-termpdf-3.png
│       ├── sshot-termpdf-4.png
│       ├── sshot-termpdf-5.png
│       └── sshot-termpdf-6.png
├── installer.sh
├── lib
│   └── mupdf-1.22.2.tar.gz
├── LICENSE
├── pdf
│   └── loremipsum.pdf
├── README.md
├── src
│   ├── loremipsum.pdf
│   ├── termpdf.c
│   ├── termpdf.cpp
│   └── termpdf.py
└── termpdf.spec

12 directories, 26 files

$ du -ch TermPDFViewer-v.0.0.2/dist/

42M TermPDFViewer-v.0.0.2/dist/macos
30M TermPDFViewer-v.0.0.2/dist/linux
71M TermPDFViewer-v.0.0.2/dist/
71M total

$ file TermPDFViewer-v.0.0.2/dist/linux/termpdf-linux

TermPDFViewer-v.0.0.2/dist/linux/termpdf-linux: ELF 64-bit LSB pie executable, x86-64, version 1 (SYSV), dynamically linked, interpreter /home/linuxbrew/.linuxbrew/lib/ld.so, for GNU/Linux 3.2.0, BuildID[sha1]=9d4f73394de2b86467af91d397559e03af86145c, stripped

Sorry to say and dont take it personal.

What a giant big ugly mess !!!

If you release the source, than you release a tar.gz archive containing text files. Maybe images or pdf docs inside. But you dont mix it with precompiled binaries and call it "source" tar.gz.

Source is "source" and the binaries are "binary". Like everyone else on github. And explain what you get in the releases in the README.

It's gonna cause a mess and confusion to users. I read your README it seems you are trying this to make the life easier for users. But it is a bad idea.

For instance, in the AUR repo. If you call your PKGBUILD "term-pdf" than it's a PKGBUILD that is supposed to pull source code that needs to be built locally on the users computer. With some "python setup this or that" or "make this or that". It is not supposed to pull precompiled binaries from the Internet and then copy them to /usr/bin.

  install -Dm755 termpdf-linux "${pkgdir}/usr/bin/term-pdf"

If you want to do that, than you make another PKBUILD called "term-pdf-bin".

So it is also completely obsolete that in have on your PKBUILD

Depends On                    : python-pip  python-pymupdf
Make Deps                     : None

You are not even using those python-pip for nothing. And worse, you are leaving it installed on the user system for no reason. It's a "make" dependency" not "normal" dependency.

Please make sure that you spend sometime and understand,

Other problems,

Number 1. Why did you choose the name for the PKGBUILD "term-pdf" ?

Instead of "termpdfviewer" ? Did you search the AUR first to see if similar names where there ?

It only confuses users as there are other AUR PKBUILD's much older also called "termpdf".

Number 2. No LICENSE no README

$ pacman -Ql term-pdf

term-pdf /usr/
term-pdf /usr/bin/
term-pdf /usr/bin/term-pdf

You have plenty of stuff inside the tar.gz

$ tar tvf TermPDFViewer-v.0.0.2.tar.gz

...
-rw-rw-r-- root/root      1081 2023-08-10 10:38 TermPDFViewer-v.0.0.2/LICENSE
-rw-rw-r-- root/root      7399 2023-08-10 10:38 TermPDFViewer-v.0.0.2/README.md
...

Maybe in the future you will also have man pages, more text files in docs, help etc.

Make sure they all end up in the right place. For example,

/usr/share/licenses/termpdfviewer/LICENSE
/usr/share/doc/termpdfviewer/README.md

etc

Number 3. Another suggestion. Edit the description,

Description:    TermPDF Viewer is an open-source PDF file viewer designed to run in the terminal.

Dont save on a few micro bytes or characters. Add the essential facts:

  • based on python
  • powered by pymupdf