Skip to main content

Downloads Documentation from ReadTheDocs in multiple formats

Project description

License Development Status

DocDownloader is a python 2/3 module/utility to download Documenation hosted on ReadTheDocs in HTML, PDF and EPUB Formats

It can be used from the terminal or by using the API.

Installation

Installing is simple, just enter this command:

pip install DocDownloader

You need to have pip installed to run this command

Usage

Just run the following command:

docdownloader [-f format] [-d directory] url/package name

For example,

docdownloader -f HTML flask

or

docdownloader -f epub http://scrapy.readthedocs.org/en/latest/

API Usage

You can use the module from python also. Example code:

from DocDownloader import DocDownloader
DocDwn=DocDownloader('flask','pdf')
DocDwn.download()

Dependencies

  1. requests

  2. BeautifulSoup4

  3. wget (the python module)

Features

  1. Download docs in HTML, EPUB and PDF Formats

  2. Automatic Server setup using http.server/SimpleHttpServer by clicking on a .bat file

Note for Linux and Mac OSX Users

The Automatic server setup is currently for Windows only. It’l be ported over soon (Once I learn some shell commands)

About

Created By Pradipta aka geekpradd.

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

DocDownloader-1.3.2.zip (6.3 kB view details)

Uploaded Source

File details

Details for the file DocDownloader-1.3.2.zip.

File metadata

  • Download URL: DocDownloader-1.3.2.zip
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for DocDownloader-1.3.2.zip
Algorithm Hash digest
SHA256 a806ecd485ad29dd081d72c08de1fa08409d3aea38ba9c8b8d6f5d861ed36b1a
MD5 54cfd87963649a16d1d8d6636d0fa678
BLAKE2b-256 dc9b4cfb067fc1fe703e7ae49b4656dc3995141f01306d8c34d0acc7ed8be229

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