mwalbeck/podweasel
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README and setup.py

Browse source
This commit is contained in:
Magnus Walbeck 2017-07-05 15:49:52 +02:00
parent 5c4c771bc5
commit 2f4ffa73ae
2 changed files with 28 additions and 13 deletions

33
README.md
View file

@ -5,12 +5,15 @@
A program for managing & catching podcasts from the terminal.
Work in Progress and unfinished. Use at your own risk.
## Requirements
requires feedparser, requests and colorama
requires feedparser, requests, colorama and tqdm
install automatically via pip:
```pip install podfox```
```
git clone https://github.com/mwalbeck/podfox.git
cd podfox
python3 setup.py install
```
## Configuration
@ -18,13 +21,25 @@ podfox main configuration file is called `.podfox.json` and should be located in
Here is mine:
```
{
"podcast-directory" : "/home/basti/podcasts",
"maxnum" : 5
"podcast-directory" : "/home/<USER>/podcasts",
"maxnum" : 5,
"cover-image" : true,
"cover-image-name" : "folder",
"rename-episodes" : true,
"date-format" : "%Y-%m-%d",
"connection-timeout" : 10,
"conncetion-retries" : 3
}
```
`podcast-directory` is your main directory to store podcast data. This directory should be empty before you
begin adding feeds.
`maxnum` describes the maximum number of episodes you want to download with a single `download`-command.
* `podcast-directory` is your main directory to store podcast data. This directory should be empty before you begin adding feeds.
* `maxnum` describes the maximum number of episodes you want to download with a single `download`-command. -1 for no limit.
* `cover-image` *(optional)* boolean value to enable downloading of podcast image (default is `false`)
* `cover-image-name` *(optional)* custom name for the image (default is `folder`)
* `rename-episodes` *(optional)* boolean value to enable renaming of podcast episodes (default is `false`)
* `date-format` *(optional)* formatting for the date when renaming episodes (default is `%Y-%m-%d`)
* `connection-timeout` *(optional)* int in seconds for how long to wait before timeout (default is `10`)
* `connection-retries` *(optional)* int for how many retries per podcast episode before moving on to next episode if there is connection problems (default is `3`)
## Directory Structure

8
setup.py
View file

@ -4,11 +4,11 @@ with open('requirements.txt') as f:
required = f.read().splitlines()
setup(name='podfox',
version='0.1.1',
version='0.1.3',
description='Podcatcher for the terminal',
url='http://github.com/brtmr/podfox',
author='Bastian Reitemeier',
author_email='mail@brtmr.de',
url='http://github.com/mwalbeck/podfox',
author='Magnus Walbeck',
author_email='mw@mwalbeck.org',
license='GPLv3',
packages=['podfox'],
zip_safe=False,