A fiction downloader, capable of retrieving works of fiction from the net and saving them in afew common file formats.
Project description
fiction-dl (1.3.0)
fiction-dl is a command-line utility used for downloading works of fiction from the web, formatting them and storing them in a few common file formats. It requires a Python interpreter installed, version 3.8 or higher.
I've created it mostly as an exercise in Python - the good old FanFicFare serves the same purpose and has a much longer list of supported sites. It can also update already downloaded stories, not to mention that it can be used as a Calibre plug-in just as well as a command-line tool! But with all that said, fiction-dl does have some adventages over FFF:
- It supports some sites FFF doesn't (Reddit).
- It can generate ODT and PDF files.
- It applies some typographic corrections to downloaded texts.
- It has much more verbose output.
Features
Downloading stories
fiction-dl is capable of downloading stories from following sites:
Fanfiction
- Archive of Our Own.
- FanFiction.net.
- SpaceBattles.com. (Supports user authentication.)
- SufficientVelocity.com. (Supports user authentication.)
- AlternateHistory.com. (Supports user authentication.)
Original Fiction
- Fiction Press.
- Reddit. (Supports user authentication.)
Erotica
Formatting stories
Downloaded stories can be saved in following file formats:
- HTML (.html).
- EPUB (.epub).
- OpenDocument (.odt).
- Portable Document Format (.pdf).
(Creating PDF output files requires LibreOffice installed on the machine.)
Embedding images
The application can download images found in story content and embed them in output files.
Typographic corrections
fiction-dl can apply basic typographic corrections to the content of downloaded stories.
Installation
You can install fiction-dl using pip:
pip install --upgrade fiction-dl
(If the package's already installed, this command will also update it.)
Usage
To download a story from a URL, simply type:
fiction-dl URL
In order to download multiple stories, create a text file and place the URLs in it, each one in a separate line. Then type:
fiction-dl YourFilesName
fiction-dl offers a few options - you can view them using following command:
fiction-dl -h
License
GNU GPL 3. The text of the license is provided in the LICENSE file.
Changelog
All changelogs can be found in the Docs/Changelogs directory.
Technical
Documentation
You can generate code documentation using Doxygen; the relevant configuration file is Docs/Docs.doxygen. Generated files will appear in the Docs/Code Documentation directory.
Tests
Launching the Integration Test can be done by entering the Tests directory and executing the following code:
python "Integration Test"
In order to launch unit tests, enter the Tests directory and execute:
python "Unit Tests.py"
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for fiction_dl-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b195b5ea40c847389ba65f2e0450f08a6522df90711c2fb94e7063a9a828492e |
|
MD5 | 4e785f4ed0e5e4fc7536c6d38e2523c2 |
|
BLAKE2b-256 | 47f4553057530f37d716c4195bdc0b7c3e02d589401e44414ffe8e8898d2f80c |