Metadata-Version: 2.4
Name: url2epub
Version: 1.1.0
Summary: A CLI program to convert an URL to an epub using Readability & Pandoc.
Author-email: berru <berru@riseup.net>
License-Expression: MIT
Project-URL: Homepage, https://git.sr.ht/~berru/url2epub
Keywords: epub,cli
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: readability-lxml
Requires-Dist: pandoc
Requires-Dist: requests
Requires-Dist: unidecode
Requires-Dist: beautifulsoup4
Dynamic: license-file

# url2epub

A CLI program to convert an URL to an epub using Readability & Pandoc.

Uses:

- _Readability_ : Removes all the menu/footers/header you don't want to read anyway.
- _Pandoc_ : Converts to `epub`/`epub3` formats.
- _Request_ : Retrieve webpage.

## installation

Needs the following python packages:

```
readability-lxml
pandoc
requests
```

recommended installation is via `pipx`

```shell
pipx install url2epub
```

## usage

Download a page (filename auto-determined from title page)

```shell
url2epub.py myverygoodwebsite.com/article
```

Download a page to a specific filename

```shell
url2epub.py myverygoodwebsite.com/article --outfile my_file.epub
```

Save to epub3 format

```shell
url2epub.py myverygoodwebsite.com/article --epub3
```
