Skip to main content

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

Project description

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

you can either get them from your package manager, or from pip.

pip install -r requirement.txt

usage

#EXAMPLE
url2epub.py myverygoodwebsite.com/article

url2epub.py --help
#usage: url2epub.py --url myverygoodwebsite.com/article --outfile /mnt/my-ereader/article.epub
#
#Downloads a webpage, extracts the readable content using Readability, and saves it to an epub to be read on your favorite e-reader using Pandoc.
#
#positional arguments:
#  URL                   URL to get the epub from. If not present, 'http://' will be prepended to the argument.
#
#options:
#  -h, --help            show this help message and exit
#  -o, --outfile OUTFILE
#                        Outfile to save the ebook to. If not present, will try to make up a name from the webpage's title. Might overwrite existing file, use with caution.
#  --epub3               Saves the book in epub3 format (default=False)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

url2epub-1.0.0.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

url2epub-1.0.0-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file url2epub-1.0.0.tar.gz.

File metadata

  • Download URL: url2epub-1.0.0.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for url2epub-1.0.0.tar.gz
Algorithm Hash digest
SHA256 1338d559f81232d8be5b076e6cd42ede57264e5e430a3e3da2ce35e7437576fe
MD5 2da843de8a3ebc516a289d8929409782
BLAKE2b-256 6306e5406918e76dd991ae1fa0c7ffdd5592b46a49d0607628840cdfdc980f31

See more details on using hashes here.

File details

Details for the file url2epub-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: url2epub-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for url2epub-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee4bb36b0133d118144cbe92117b3c3c90e04f9e480d6b36e176b91c121eef19
MD5 612cfd665ccd53dd098a0af7b4e2b5f2
BLAKE2b-256 e060cac3bbf018a082d48beffb05aeb9c77a28b933352e33a51712d74993e55b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page