Metadata-Version: 1.1
Name: ctdl
Version: 1.4.1
Summary: Bulk file downloader on any topic.
Home-page: http://github.com/nikhilkumarsingh/gnewsclient
Author: Nikhil Kumar Singh
Author-email: nikhilksingh97@gmail.com
License: MIT
Description: |PyPI| |license|
        
        content-downloader
        ==================
        
        Python package with **command line utility** to download files on any
        topic in bulk.
        
        .. figure:: https://media.giphy.com/media/3oKIPlt7APHqWuVl3q/giphy.gif
           :alt: 
        
        **Features:** - 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://%20github.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``
        
        Command line usage
        ------------------
        
        ::
        
            $ ctdl [-h] [-f FILE_TYPE] [-l LIMIT] [-d DIRECTORY] [-p] [-a] [-t] [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.
        
        Here are some 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``
        
        Usage in Python files
        ---------------------
        
        .. code:: python
        
            from ctdl import ctdl
        
            filetype = 'ppt'
            limit = 5
            directory = '/home/nikhil/Desktop/ml-pdfs'
            query = 'machine learning using python'
        
            ctdl.download_content(query, filetype, directory, limit)
        
        TODO
        ----
        
        -  [X] Prompt user before downloading potentially threatful files
        -  [ ] Implement unit testing
        -  [ ] Create ctdl GUI
        -  [ ] Use DuckDuckgo API as an option
        
        Want to contribute?
        -------------------
        
        -  Clone the repository
        
        ``$ git clone http://github.com/nikhilkumarsingh/content-downloader``
        
        -  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.4-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
        
Keywords: content downloader bulk files
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet
