ctdl 1.5.0
Bulk file downloader on any topic.
License: MIT
Keywords: content downloader bulk files

|PyPI| |license|

content-downloader
==================

**content-downloader** a.k.a **ctdl** is a python package with **command
line utility** and **desktop GUI** to download files on any topic in
bulk!

.. figure:: https://media.giphy.com/media/3oKIPlt7APHqWuVl3q/giphy.gif
   :alt: 

.. figure:: https://media.giphy.com/media/xUPGcIvGpH3KvEmlnG/giphy.gif
   :alt: 

Features
--------

-  ctdl can be used as a command line utility as well as a desktop GUI.

-  ctdl fetches file links related to a search query from **Google
   Search**.

-  Files can be downloaded parallely using multithreading.

-  ctdl is Python 2 as well as Python 3 compatible.

Installation
------------

-  To install content-downloader, simply,

``$ pip install ctdl``

-  There seem to be some issues with parallel progress bars in tqdm
   which have been resolved in this
   `pull <https://github.com/tqdm/tqdm/pull/385>`__. Until this pull is
   merged, please use my patch by running this command:

``$ pip install -U git+https://github.com/nikhilkumarsingh/tqdm``

Desktop GUI usage
-----------------

To use **ctdl** desktop GUI, open terminal and run this command:

::

    $ ctdl-gui

Command line usage
------------------

::

    $ ctdl [-h] [-f FILE_TYPE] [-l LIMIT] [-d DIRECTORY] [-p] [-a] [-t]
           [-minfs MIN_FILE_SIZE] [-maxfs MAX_FILE_SIZE] [-nr]
           [query]

Optional arguments are:

-  -f FILE\_TYPE : set the file type. (can take values like ppt, pdf,
   xml, etc.)

   ::

                Default value: pdf

-  -l LIMIT : specify the number of files to download.

   ::

            Default value: 10

-  -d DIRECTORY : specify the directory where files will be stored.

   ::

                Default: A directory with same name as the search query in the current directory.

-  -p : for parallel downloading.

-  -minfs MIN\_FILE\_SIZE : specify minimum file size to download in
   Kilobytes (KB).

   ::

                Default: 0

-  -maxfs MAX\_FILE\_SIZE : specify maximum file size to download in
   Kilobytes (KB).

   ::

                Default: -1 (represents no maximum file size)

-  -nr : prevent download redirects.

   ::

                Default: False

Examples
--------

-  To get list of available filetypes:

``$ ctdl -a``

-  To get list of potential high threat filetypes:

``$ ctdl -t``

-  To download pdf files on topic 'python':

``$ ctdl python`` This is the default behaviour which will download 10
pdf files in a folder named 'python' in current directory.

-  To download 3 ppt files on 'health':

``$ ctdl -f ppt -l 3 health``

-  To explicitly specify download folder:

``$ ctdl -d /home/nikhil/Desktop/ml-pdfs machine-learning``

-  To download files parallely: ``$ ctdl -f pdf -p python``

-  To search for and download in parallel 10 files in PDF format
   containing the text "python" and "algorithm", without allowing any
   url redirects, and where the file size is between 10,000 KB (10 MB)
   and 100,000KB (100 MB), where KB means Kilobytes, which has an
   equivalent value expressed in Megabytes:
   ``$ ctdl -f pdf -l 10 -minfs 10000 -maxfs 100000 -nr -p "python algorithm"``

Usage in Python files
---------------------

.. code:: python

    from ctdl import ctdl

    ctdl.download_content(
    file_type = 'ppt',
    limit = 5,
    directory = '/home/nikhil/Desktop/ml-pdfs',
    query = 'machine learning using python')

TODO
----

-  [X] Prompt user before downloading potentially threatful files

-  [X] Create ctdl GUI

-  [ ] Implement unit testing

-  [ ] Use DuckDuckgo API as an option

Want to contribute?
-------------------

-  Clone the repository

``$ git clone http://github.com/nikhilkumarsingh/content-downloader``

-  Install dependencies ``$ pip install -r requirements.txt``

**Note:** There seem to be some issues with current version of tqdm. If
you do not get expected progress bar behaviour, try this patch:

``$ pip uninstall tqdm   $ pip install git+https://github.com/nikhilkumarsingh/tqdm``

-  In ctdl/ctdl.py, remove the ``.`` prefix from ``.downloader`` and
   ``.utils`` for the following imports, so it changes from:
   ``python   from .downloader import download_series, download_parallel   from .utils import FILE_EXTENSIONS, THREAT_EXTENSIONS``
   to:
   ``python   from downloader import download_series, download_parallel   from utils import FILE_EXTENSIONS, THREAT_EXTENSIONS``

-  Run the python file directly ``python ctdl/ctdl.py ___`` (instead of
   with ``ctdl ___``)

.. |PyPI| image:: https://img.shields.io/badge/PyPi-v1.5-f39f37.svg
   :target: https://pypi.python.org/pypi/ctdl
.. |license| image:: https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000
   :target: https://github.com/nikhilkumarsingh/content-downloader/blob/master/LICENSE.txt