Metadata-Version: 1.1
Name: ctdl
Version: 1.0.0
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 to download files on any topic in bulk.
        
        content-downloader supports Python 2 as well as Python 3.
        
        Installation
        ------------
        
        To install content-downloader, simply,
        
        ::
        
            $ pip install ctdl
        
        Command line usage
        ------------------
        
        ::
        
            $ ctdl [-h] [-f FILE_TYPE] [-l LIMIT] [-d DIRECTORY] [-a] [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.
        
        Here are some examples:
        
        -  To get list of available filetypes: ``$ ctdl -a``
        
        -  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 expicitly specify download folder:
           ``$ ctdl -d /home/nikhil/Desktop/ml-pdfs machine learning``
        
        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)
        
        .. |PyPI| image:: https://img.shields.io/badge/PyPi-v1.0.2-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
