Skip to main content

Novel downloader

Project description

novel-dl

This tool enables you to download novels from "syosetu.com" or "kakuyomu.jp" and read them even if you are offline.
このツールは「小説家になろう」や「カクヨム」から小説をダウンロードし、オフラインでも読むことを可能にするものです。

Description (概要)

novel-dl is a command-line program to download novels from syosetu.com or kakuyomu.jp.
It downloads novel data from those sites and generates html with files such as css, javascript and images for offline use.
It requires the Python interpreter and version 3.6+ and need to run on unix based platform.
It should work on MacOS and Linux such as Ubuntu and CentOS, that is, Unix-like operating systems. Not tested on Windows.
It is released to the public domain, which means you can modify it, redistribute it or use it however you like.

novel-dlは、「小説家になろう」や「カクヨム」から小説をダウンロードするためのコマンドラインプログラムです。
小説のデータをダウンロードし、オフラインでも使用するためにcss、javascript、画像などとhtmlを生成します。
Pythonのバージョン3.3以降が必要であり、UNIXベースのプラットフォームで実行する必要があります。
UbuntuやCentOSなどのMacOSおよびLinux、つまりUnix系OSで動作するはずです。 Windowsではテストされていません。
これはパブリックドメインにリリースされます。つまり、好きなように変更、再配布、または使用することができます。

DEMO

demo

Usage (使い方)

novel-dl [OPTIONS] <src> [<src> ...]

Options

General Options

  • -h, --help
    ヘルプを出力します
  • -v, --version
    バージョン情報を出力します
  • -q, --quiet
    エラー以外の出力を制限します。

Downloader Options

  • -a, --axel
    遅延時間を無くすことでダウンロード速度を加速させます。
    ※遅延時間を設けているのはサーバーに過度な負担をかけないためです。
    何度もこのオプションを用いてダウンロードするとサイト側の利用規約の禁止事項に抵触する可能性があります。

Formatter Options

  • -t, --theme
    出力するファイルのテーマを指定します。
    これにより、小説の取得元に関わらず、決まった見た目のファイルを出力することができます。
    "auto"を指定することで取得元に合わせたテーマを自動で選ぶこともできます。

  • -m, --media
    ファイルを特定のメディアタイプ用のみのスタイルで出力します。
    多くの場合、これはファイルサイズ削減のために使用されます。
    使用するテーマによって指定できるメディアタイプが違います。

  • -r, --renew
    すでに存在する話をスキップせず、上書きし、更新します。

  • -e, --episode
    特定の話を指定し、短編と同じような形で出力します。

Output Options

  • -n, --name
    出力フォルダ名、または出力ファイル名をのテンプレートを指定します。 フォルダ名にはstrftimeの書式及び、以下のテンプレートが使用できます。
    "{"および"}"をエスケープする場合には
    "{"を"{{"に、"}"を"}}"に置き換えます。

    • title Novel title (default)
    • ncode Novel identifier
    • theme Novel format theme
    • media Novel format media type
    • type Novel type (series, single)
    • episode Novel episode number
  • -d, --dir
    生成したファイル群の出力先フォルダを指定します。

Requirement (環境)

  • Unix-like operating systems
  • Python >= 3.6
  • [Main libraries]
    • beautifulsoup4
    • Jinja2
    • pytz
    • requests
    • tqdm

Installation (インストール方法)

$ pip3 install novel-dl

or

$ pip3 install git+https://github.com/Keinsleif/novel-dl.git

or

$ git clone https://github.com/Keinsleif/novel-dl.git
$ cd novel-dl
$ python3 setup.py install

Note

Please be sure use the generated novels data only for private.
出力された小説データの使用はは絶対に個人使用に限定してください

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

novel_dl-1.6.2.tar.gz (474.0 kB view details)

Uploaded Source

Built Distribution

novel_dl-1.6.2-py3-none-any.whl (499.2 kB view details)

Uploaded Python 3

File details

Details for the file novel_dl-1.6.2.tar.gz.

File metadata

  • Download URL: novel_dl-1.6.2.tar.gz
  • Upload date:
  • Size: 474.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for novel_dl-1.6.2.tar.gz
Algorithm Hash digest
SHA256 cb15fb301c635346f61207bf50fadb24a6ed3e8faff41cee83c9255a35e908b4
MD5 2182bfcaeb5d5f28462e766162197232
BLAKE2b-256 8947593c41573ad96c09e013694a85fe6705bd89957a98e6698fc927681a5e7f

See more details on using hashes here.

File details

Details for the file novel_dl-1.6.2-py3-none-any.whl.

File metadata

  • Download URL: novel_dl-1.6.2-py3-none-any.whl
  • Upload date:
  • Size: 499.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.6

File hashes

Hashes for novel_dl-1.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f6a3952f809f5ea9b8ab07322d3db209e34606faf197ad9bc73a299a9c60bf4b
MD5 eaea56aa3ce3723e7b2cbc1beb3d4c41
BLAKE2b-256 efca653a85051eaa9a257130eb7c856beeaffa5ecca68aeb59d58a1bc8f57f87

See more details on using hashes here.

Supported by

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