Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/2mol/pboy
a small .pdf management tool with a command-line UI
https://github.com/2mol/pboy
command-line console-application haskell linux macos pdf productivity tui
Last synced: about 2 months ago
JSON representation
a small .pdf management tool with a command-line UI
- Host: GitHub
- URL: https://github.com/2mol/pboy
- Owner: 2mol
- License: bsd-3-clause
- Created: 2018-05-07T13:41:54.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2022-06-11T15:51:12.000Z (over 2 years ago)
- Last Synced: 2024-06-20T05:26:36.359Z (3 months ago)
- Topics: command-line, console-application, haskell, linux, macos, pdf, productivity, tui
- Language: Haskell
- Homepage:
- Size: 671 KB
- Stars: 733
- Watchers: 12
- Forks: 24
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.txt
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: code_of_conduct.md
Awesome Lists containing this project
README
[](https://github.com/2mol/pboy/actions)
Paperboy is a tiny .pdf management utility.
If you download papers and other pdf documents, you might have noticed that filenames like `1412.4880.pdf` are not terribly helpful for finding anything later on. Especially if your download folder _also_ contains about eighty files along the lines of `catloaf.jpg`, `David_Lynch_Teaches_Typing.zip`, and `160502_0001.wav`.
This tool helps with that. It will offer to rename and move files to a specified folder, and it even gives some filename suggestions by looking at the content and the pdf metadata.
Paperboy keeps its file management dumb on purpose (no keeping files in a database or hidden library folder), so you can uninstall it at any time and your files will remain perfectly accessible.
# Usage
- Open a new file import dialog with Enter or Space.
- Switch between inbox and library with Tab.
- Open a file from the library with Enter or Space.
- Rename an already imported file with r.
- Quit the application with Esc or q or abort with Ctrl + c.
# Install
## Homebrew on macOS
If you're a Homebrew user, you can install the latest version and its dependencies from the repo's tap:
```
$ brew install 2mol/tools/pboy
```
## Linux/Mac binary release
Download the archive for your operating system from [https://github.com/2mol/pboy/releases](https://github.com/2mol/pboy/releases). Extract and install it with
```
$ tar zxvf pboy*.tar.gz
$ mv pboy ~/.local/bin/
```
For the latter to work, `~/.local/bin/` needs to exist and be in your `PATH`. Alternatively, put it in `/usr/local/bin`.
## Linux, any distro
I am still looking to package Paperboy for Debian/Ubuntu, Arch/Manjaro, Fedora, Doge Linux, or whatever else people install these days.
Any pointers or help with regards to generate `.deb`, `.rpm`, AUR `PKGBUILD`, etc is appreciated. Ideally this could be mostly automated in CI, in the end Paperboy is just a single binary with a dependency or two. How do other packages do it? If you got a good example or link, open a GitHub issue!
## Cabal/Stack
Make sure you have `poppler` installed, which will provide both `pdftotext` and `pdfinfo`. On Linux, install `poppler` with your package manager of choice. If you are on Mac and using Homebrew you can do `brew install poppler`.
Assuming you have cabal or stack, the following will compile, then install the `pboy` executable in your `.local/bin`:
```
$ git clone [email protected]:2mol/pboy.git
$ cd pboy
$ stack install
```
Replace `stack install` with `cabal new-install` at your leisure.
## Nix
If you have Nix, then you can install `pboy` with a single command:
```
$ nix-env -if https://github.com/2mol/pboy/tarball/main
```
# Config
Paperboy creates a `pboy.ini` in your XDG config directory. This is probably in `~/.config/pboy/pboy.ini`, the welcome or help screen will tell you. Use this to change your library and incoming folders, as well as to specify whether you want to move the imported files or just copy them.
# Current Limitations
Paperboy doesn't do anything fancy with providing renaming patterns yet. For example, some people requested to be able to specify a format like `author-document_name-date.pdf`, others have asked if they could compose multiple suggestions into one. I haven't figured out a way to do this while keeping the UI simple and straightforward, so the idea needs a bit of design work first.
# Contribute
You're very welcome to suggest new features or open issues. See the Roadmap https://github.com/2mol/pboy/blob/main/Roadmap.md to get an idea about what's planned for future releases.
Releases can be created by pushing a new tag:
```bash
git tag -a 1.99rc1 -m "release candidate 1.99"
git push --follow-tags
```
This will publish compiled assets for OSX and Linux, but only create a prerelease. Once you're confident that the executable isn't broken, a repo contributor can mark the version as a release.
Finally, to publish the new version via Homebrew, the [tools repo](https://github.com/2mol/homebrew-tools) has to be updated with the SHA256 of `pboy-osx.tar.gz`. You can find it in the CI logs, or you could run `shasum -a 256 pboy-osx.tar.gz` manually.
# Thanks
- [brick](https://github.com/jtdaugherty/brick) is a lovely way to a write a command-line UI.
- [nmattia](https://github.com/nmattia) did the work to get Paperboy to build with [nix](https://github.com/NixOS/nix) and patiently explained some of the basics to me.
- OsugiSakae and bri-an on reddit helped me with an annoying performance issue!
- [Nils Steinger](https://github.com/n-st) for feature contributions.
- [Adrian Sieber](https://github.com/ad-si) for contributing.
The name 'Paperboy' is a reference to [this game](https://en.wikipedia.org/wiki/Paperboy_(video_game)), which I had for the NES and never quite mastered.