Metadata-Version: 2.1
Name: poddl
Version: 0.3.0
Summary: Downloads podcasts from RSS feeds
Home-page: https://github.com/benkyriakou/poddl
Author: Ben Kyriakou
Author-email: benkyriakou@users.noreply.github.com
License: MIT
Description: # poddl
        
        poddl downloads podcasts from RSS feeds, both as a CLI tool and a Python library.
        
        poddl attempts to achieve filesystem compatibility by ASCII-fying podcast titles using a combination of [unidecode](https://github.com/avian2/unidecode) and character-stripping, so the titles you see may not be exactly the same as those given in the RSS feed.
        
        ## Installation
        
        Install via `pip`:
        
        ```
        pip install poddl
        ```
        
        ## CLI
        
        poddl makes itself available as a CLI utility. For options, see `poddl --help`:
        
        ```
        usage: poddl [-h] --url URL [--summary] [--destination DESTINATION]
                     [--limit LIMIT]
        
        A basic RSS podcast downloading script
        
        optional arguments:
          -h, --help            show this help message and exit
          --url URL             The RSS feed URL
          --summary             Show a summary of available episodes
          --destination DESTINATION
                                Directory to save podcast files to
          --limit LIMIT         Limit the number of items retrieved
        ```
        
        By default, podcasts are downloaded to `~/Downloads/poddl`.
        
        ## Library
        
        To use as a library, include `poddl.get`:
        
        ```python3
        from poddl import get
        
        get('https://example.com/rss')
        ```
        
        By default episodes are downloaded to `~/Downloads/poddl`. To change this, set the destination:
        
        ```python3
        from poddl import get
        
        get('https://example.com/rss', destination='~/Documents/podcasts')
        ```
        
        You can get a listing of the available podcasts without downloading them using `summary`:
        
        ```python3
        from poddl import get
        
        summary = get('https://example.com/rss', summary=True)
        ```
        
        Here summary will be a list of podcast titles.
        
        You can limit the number retrieved with `limit`:
        
        ```python3
        from poddl import get
        
        get('https://example.com/rss', summary=True, limit=20)
        ```
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Description-Content-Type: text/markdown
