paperoni/README.md

127 lines
4.5 KiB
Markdown
Raw Normal View History

2020-10-22 18:00:43 +01:00
<p align="center"><img src="./paperoni-dark.png"></p>
2020-10-22 14:03:57 +01:00
<p align="center"><i>Salami not included</i></p>
2020-10-22 14:03:57 +01:00
2021-05-13 10:26:23 +01:00
<div align="center">
<a href="https://crates.io/crates/paperoni">
<img alt="crates.io version" src="https://img.shields.io/crates/v/paperoni.svg">
</a>
</div>
2021-04-30 04:55:02 +01:00
Paperoni is a CLI tool made in Rust for downloading web articles as EPUBs.
2020-10-22 14:03:57 +01:00
2021-02-24 10:17:13 +00:00
> This project is in an alpha release so it might crash when you use it. Please open an [issue on Github](https://github.com/hipstermojo/paperoni/issues/new) if it does crash.
## Installation
### Precompiled binaries
Check the [releases](https://github.com/hipstermojo/paperoni/releases) page for precompiled binaries. Currently there are only builds for Debian and Arch.
### Installing from crates.io
Paperoni is published on [crates.io](https://crates.io). If you have [cargo](https://github.com/rust-lang/cargo) installed, then run:
```sh
2021-05-24 18:28:23 +01:00
cargo install paperoni --version 0.4.1-alpha1
2021-02-24 10:17:13 +00:00
```
_Paperoni is still in alpha so the `version` flag has to be passed._
### Building from source
This project uses `async/.await` so it should be compiled using a minimum Rust version of 1.33. Preferrably use the latest version of Rust.
```sh
git clone https://github.com/hipstermojo/paperoni.git
cd paperoni
## You can build and install paperoni locally
cargo install --path .
## or use it from within the project
cargo run -- # pass your url here
```
2020-10-22 14:03:57 +01:00
## Usage
2021-04-30 04:55:02 +01:00
```
USAGE:
paperoni [OPTIONS] [urls]...
OPTIONS:
-f, --file <file> Input file containing links
-h, --help Prints help information
--log-to-file Enables logging of events to a file located in .paperoni/logs with a default log level
of debug. Use -v to specify the logging level
--max_conn <max_conn> The maximum number of concurrent HTTP connections when downloading articles. Default is
8
--merge <output_name> Merge multiple articles into a single epub
-V, --version Prints version information
-v Enables logging of events and set the verbosity level. Use -h to read on its usage
ARGS:
<urls>... Urls of web articles
```
To download a single article pass in its URL
2020-10-22 14:03:57 +01:00
```sh
paperoni https://en.wikipedia.org/wiki/Pepperoni
```
Paperoni also supports passing multiple links as arguments.
```sh
paperoni https://en.wikipedia.org/wiki/Pepperoni https://en.wikipedia.org/wiki/Salami
```
Alternatively, if you are on a Unix-like OS, you can simply do something like this:
2020-10-22 14:03:57 +01:00
```sh
cat links.txt | xargs paperoni
```
2021-02-24 10:17:13 +00:00
These can also be read from a file using the `-f/--file` flag.
```sh
paperoni -f links.txt
```
2021-02-24 10:17:13 +00:00
### Merging articles
By default, Paperoni generates an epub file for each link. You can also merge multiple links
into a single epub using the `merge` flag and specifying the output file.
```sh
paperoni -f links.txt --merge out.epub
```
2021-04-30 04:55:02 +01:00
### Logging events
Logging is disabled by default. This can be activated by either using the `-v` flag or `--log-to-file` flag. If the `--log-to-file` flag is passed the logs are sent to a file in the default Paperoni directory `.paperoni/logs` which is on your home directory. The `-v` flag configures the verbosity levels such that:
```
-v Logs only the error level
-vv Logs only the warn level
-vvv Logs only the info level
-vvvv Logs only the debug level
```
If only the `-v` flag is passed, the progress bars are disabled. If both `-v` and `--log-to-file` are passed then the progress bars will still be shown.
2020-10-22 14:03:57 +01:00
## How it works
The URL passed to Paperoni is fetched and the returned HTML response is passed to the extractor.
2021-04-30 04:55:02 +01:00
This extractor retrieves a possible article using a [custom port](https://github.com/hipstermojo/paperoni/blob/master/src/moz_readability/mod.rs) of the [Mozilla Readability algorithm](https://github.com/mozilla/readability). This article is then saved in an EPUB.
2020-10-22 14:03:57 +01:00
> The port of the algorithm is still unstable as well so it is not fully compatible with all the websites that can be extracted using Readability.
## How it (currently) doesn't work
This program is still in alpha so a number of things won't work:
2020-10-22 14:03:57 +01:00
- Websites that only run with JavaScript cannot be extracted.
- Website articles that cannot be extracted by Readability cannot be extracted by Paperoni either.
- Code snippets on Medium articles that are lazy loaded will not appear in the EPUB.
2021-04-30 04:55:02 +01:00
There are also web pages it won't work on in general such as Twitter and Reddit threads.