| Name | generss JSON |
| Version |
0.3.1
JSON |
| download |
| home_page | None |
| Summary | Generate RSS feeds from media files in a directory |
| upload_time | 2024-12-01 12:38:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.4 |
| license | MIT License |
| keywords |
rss
podcast
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# genRSS
`genRSS` is a tool to create an RSS 2.0 feed from media files in a directory.
Files can be looked for recursively in subdirectories and can be restricted to a
given set of extensions.
## Installation
Another package named `genrss` already exists on pypi, we use `generss` (with an
*e* after the *n*) for installation:
pip install generss
Once installed, you can use `genRSS` on the command line.
## Determining file duration
To include media file duration in your feeds (using the `<itunes:duration>` tag),
`genRSS` use tries the following options.
- `mutagen`: a python package installed alongside `genRSS` that can deal with
audio and video files.
- `sox`: can only handle audio files, runs faster than `ffprobe`.
- `ffprobe`: normally installed with `ffmpeg`, can deal with audio and video files
but it is the slowest of the three options.
In any case, if `genRSS` fails to get media file duration with one tool, it'll
fall back to the next one. If none of these tools is installed or if file duration
cannot be obtained, no `<itunes:duration>` tag will be inserted.
## Usage options
Type `genRSS -h` to show the usage options:
```
-d DIRECTORY, --dirname DIRECTORY
Directory to look for media files in.
This directory name will be appended to the host name
to create absolute paths to your media files.
-r, --recursive Look for media files recursively in subdirectories
[Default:False]
-e STRING, --extensions STRING
A comma separated list of extensions (e.g. mp3,mp4,avi,ogg)
[Default: all files]
-o FILE, --out FILE Output RSS file [default: stdout]
-H URL, --host URL Host name (or IP address), possibly with a protocol
(default: http) a port number and the path to the base
directory where your media directory is located.
Examples of host names:
- http://localhost:8080 [default]
- mywebsite.com/media/JapaneseLessons
- mywebsite
- 192.168.1.12:8080
- http://192.168.1.12/media/JapaneseLessons
-i URL, --image URL Absolute or relative URL for feed's image [default: None]
-M, --metadata Use media files' metadata to extract item title [default: False]
-t STRING, --title STRING
Title of the podcast [Default: use directory name as title]
-p STRING, --description STRING
Description of the podcast [Default:None]
-C, --sort-creation Sort files by date of creation instead of name (default)
-v, --verbose set verbose [default: False]
```
### License
MIT
Raw data
{
"_id": null,
"home_page": null,
"name": "generss",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.4",
"maintainer_email": null,
"keywords": "RSS, podcast",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9f/36/6bb762e20932b46c6baaf0a70e693ed90fc9f71ef0a29841b08d6f526fd4/generss-0.3.1.tar.gz",
"platform": null,
"description": "# genRSS\n\n`genRSS` is a tool to create an RSS 2.0 feed from media files in a directory.\nFiles can be looked for recursively in subdirectories and can be restricted to a\ngiven set of extensions.\n\n## Installation\n\nAnother package named `genrss` already exists on pypi, we use `generss` (with an\n*e* after the *n*) for installation:\n\n pip install generss\n\nOnce installed, you can use `genRSS` on the command line.\n\n## Determining file duration\n\nTo include media file duration in your feeds (using the `<itunes:duration>` tag),\n`genRSS` use tries the following options.\n\n- `mutagen`: a python package installed alongside `genRSS` that can deal with\naudio and video files.\n- `sox`: can only handle audio files, runs faster than `ffprobe`.\n- `ffprobe`: normally installed with `ffmpeg`, can deal with audio and video files\nbut it is the slowest of the three options.\n\nIn any case, if `genRSS` fails to get media file duration with one tool, it'll\nfall back to the next one. If none of these tools is installed or if file duration\ncannot be obtained, no `<itunes:duration>` tag will be inserted.\n\n\n## Usage options\n\nType `genRSS -h` to show the usage options:\n\n```\n -d DIRECTORY, --dirname DIRECTORY\n Directory to look for media files in.\n This directory name will be appended to the host name\n to create absolute paths to your media files.\n -r, --recursive Look for media files recursively in subdirectories\n [Default:False]\n -e STRING, --extensions STRING\n A comma separated list of extensions (e.g. mp3,mp4,avi,ogg)\n [Default: all files]\n -o FILE, --out FILE Output RSS file [default: stdout]\n -H URL, --host URL Host name (or IP address), possibly with a protocol\n (default: http) a port number and the path to the base\n directory where your media directory is located.\n Examples of host names:\n - http://localhost:8080 [default]\n - mywebsite.com/media/JapaneseLessons\n - mywebsite\n - 192.168.1.12:8080\n - http://192.168.1.12/media/JapaneseLessons\n -i URL, --image URL Absolute or relative URL for feed's image [default: None]\n -M, --metadata Use media files' metadata to extract item title [default: False]\n -t STRING, --title STRING\n Title of the podcast [Default: use directory name as title]\n -p STRING, --description STRING\n Description of the podcast [Default:None]\n -C, --sort-creation Sort files by date of creation instead of name (default)\n -v, --verbose set verbose [default: False]\n```\n\n\n### License\nMIT\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Generate RSS feeds from media files in a directory",
"version": "0.3.1",
"project_urls": null,
"split_keywords": [
"rss",
" podcast"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "950c2b8dae8deb0a0b43939a5cbcdb6d4180138dfa9e48d0ce8608a14fd2ffae",
"md5": "576b8a1440c4723563608ad51a882503",
"sha256": "8c98da5d9c52c76d581903025c88f7fa8bdfb3621ba578d00d6d5c35632e63e3"
},
"downloads": -1,
"filename": "generss-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "576b8a1440c4723563608ad51a882503",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.4",
"size": 11598,
"upload_time": "2024-12-01T12:38:12",
"upload_time_iso_8601": "2024-12-01T12:38:12.875650Z",
"url": "https://files.pythonhosted.org/packages/95/0c/2b8dae8deb0a0b43939a5cbcdb6d4180138dfa9e48d0ce8608a14fd2ffae/generss-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f366bb762e20932b46c6baaf0a70e693ed90fc9f71ef0a29841b08d6f526fd4",
"md5": "4c2a247647f137cdddabb508e0fbef04",
"sha256": "1fc2ff7918d81e57cd82186ef27d545709f29c2c4d722b500d99893056991ee1"
},
"downloads": -1,
"filename": "generss-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "4c2a247647f137cdddabb508e0fbef04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.4",
"size": 11943,
"upload_time": "2024-12-01T12:38:23",
"upload_time_iso_8601": "2024-12-01T12:38:23.873188Z",
"url": "https://files.pythonhosted.org/packages/9f/36/6bb762e20932b46c6baaf0a70e693ed90fc9f71ef0a29841b08d6f526fd4/generss-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-01 12:38:23",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "generss"
}
