# RSSPod-dl
Python-based CLI tool for downloading and managing podcast episodes from RSS feeds.
### Install Package
```shell
pip install RSSPod-dl
```
## Description
This program is a multi-threaded podcast downloader. It can download a single podcast or multiple podcasts from a list. The metadata of the original podcast episodes is maintained in the downloaded MP3 files.
---
## Usage
To run the program, use the following command:
```shell
rsspod <command> [<args>]
```
**Where:**
- `<command>` is either `download` for a single podcast or `download_all` for multiple podcasts
- `<args>` are the arguments for the command. For `download`, provide the **URL** of the podcast. For `download_all`, provide the **path** to the file containing the list of podcasts.
> for more information and features, use the `--help` flag with the command
```shell
rsspod --help
```
### Download a Single Podcast
To download a single podcast, use the **download** command and provide the URL of the podcast:
```shell
rsspod download https://example.com/podcast.rss
```
### Download Multiple Podcasts
To download multiple podcasts, use the **download_all** command and provide the path to the file containing the list of podcasts:
```shell
rsspod download_all /path/to/podcast_list.txt
```
if no file is provided, the program will look for a file named `podcast_list.txt` in the current directory.
All podcasts in the file will be downloaded
### Adding Podcasts to the List
The file should contain the name of the podcast followed by a colon and then the URL of the podcast. Lines starting with # are treated as comments and those podcasts will not be downloaded. Here's an example of the file structure:
```txt
Podcast Name:Podcast RSS Feed URL
```
Here's an example:
```txt
Lost Terminal:https://www.spreaker.com/show/4488937/episodes/feed
```
In this example, "Lost Terminal" is the name of the podcast and "https://www.spreaker.com/show/4488937/episodes/feed" is the RSS feed URL of the podcast.
If you want to add a comment or note to yourself in the file, start the line with a `#`. The program will ignore these lines when downloading podcasts. For example:
```txt
# This is my favorite podcast
Modem Prometheus:https://www.spreaker.com/show/5184621/episodes/feed
```
Or you can use it to disable a podcast from being downloaded. For example:
```txt
# This is my favorite podcast
Lost Terminal:https://www.spreaker.com/show/4488937/episodes/feed
# Modem Prometheus:https://www.spreaker.com/show/5184621/episodes/feed
```
Once you have prepared your list, save the file. When running the `download_all` command, provide the path to this file:
```shell
rsspod download_all /path/to/podcast_list.txt
```
If no file is provided, the program will look for a file named `podcast_list.txt` in the current directory.
```txt
#Lost Terminal:https://www.spreaker.com/show/4488937/episodes/feed
Modem Prometheus:https://www.spreaker.com/show/5184621/episodes/feed
```
In this example, the "Lost Terminal" podcast will not be downloaded because its line starts with #. Each non-comment line represents a separate podcast with its corresponding RSS feed URL. The program will download all episodes from each provided podcast URL.
>Credits to [Tris](https://github.com/0atman) for the best SCI-FI podcast out there [Lost Terminal](https://lostterminal.com/).
---
### Dependencies
This program uses the following Python packages:
- `requests`: Used for making HTTP requests to download the podcast episodes.
- `bs4` (BeautifulSoup): Used for parsing the XML of the RSS feeds.
- `eyed3`: Used for handling ID3 tags in the downloaded MP3 files.
- `os` and `argparse`: Used for file operations and command line argument parsing, respectively.
- `alive_progress`: Used for displaying a progress bar while the podcasts are being downloaded.
- `io`: Used for handling byte streams.
- `time`: Used for time-related tasks.
- `socket`: Used for low-level networking interface.
- `re`: Used for regular expression operations.
You can install these packages using pip:
```shell
pip install requests bs4 eyed3 alive_progress
```
Note: `os`, `argparse`, `io`, `time`, `socket`, and re are part of the Python standard library, so you don't need to install them separately.
---
### Build Yourself (Optional)
If you want to build this project yourself, follow these steps
1. clone the repository
```shell
git clone https://github.com/yourusername/RSSPod_dl.git
```
2. Install the package
```shell
cd RSSPod_dl
pip install .
```
---
## License
This program is released under the MIT License. See the `LICENSE` file for more details.
---
## About
This project was born out of a personal need. As a podcast listener, I wanted a simple way to download my favorite podcasts from various sources and sync them to my iPod. This tool allows me to do just that - it downloads multiple podcasts and organizes them in a single directory, making it easy to transfer and listen to them on my device.
This is one of my first projects and I'm still learning, so feel free to correct me or suggest improvements, raise issues or contribute to the project!
Raw data
{
"_id": null,
"home_page": "https://github.com/rimaout/RSSPod-dl",
"name": "RSSPod-dl",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python,podcast downloader,RSS",
"author": "mariout",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/7f/0d/7def272222d6e2b5dff4ef3acd8d491684f22df58bfbd5ef5b9707652e37/RSSPod-dl-1.0.1.tar.gz",
"platform": null,
"description": "# RSSPod-dl\n\nPython-based CLI tool for downloading and managing podcast episodes from RSS feeds.\n\n### Install Package\n\n```shell\npip install RSSPod-dl\n```\n\n## Description\n\nThis program is a multi-threaded podcast downloader. It can download a single podcast or multiple podcasts from a list. The metadata of the original podcast episodes is maintained in the downloaded MP3 files.\n\n---\n\n## Usage\n\nTo run the program, use the following command:\n\n```shell\nrsspod <command> [<args>]\n```\n\n**Where:** \n- `<command>` is either `download` for a single podcast or `download_all` for multiple podcasts \n- `<args>` are the arguments for the command. For `download`, provide the **URL** of the podcast. For `download_all`, provide the **path** to the file containing the list of podcasts.\n\n> for more information and features, use the `--help` flag with the command\n ```shell\n rsspod --help\n ``` \n\n### Download a Single Podcast\nTo download a single podcast, use the **download** command and provide the URL of the podcast:\n\n```shell\nrsspod download https://example.com/podcast.rss\n```\n\n### Download Multiple Podcasts\n\nTo download multiple podcasts, use the **download_all** command and provide the path to the file containing the list of podcasts:\n\n```shell\nrsspod download_all /path/to/podcast_list.txt\n```\n\nif no file is provided, the program will look for a file named `podcast_list.txt` in the current directory.\n\nAll podcasts in the file will be downloaded\n\n### Adding Podcasts to the List\nThe file should contain the name of the podcast followed by a colon and then the URL of the podcast. Lines starting with # are treated as comments and those podcasts will not be downloaded. Here's an example of the file structure:\n\n```txt\nPodcast Name:Podcast RSS Feed URL\n```\n\nHere's an example:\n\n```txt\nLost Terminal:https://www.spreaker.com/show/4488937/episodes/feed\n```\n\nIn this example, \"Lost Terminal\" is the name of the podcast and \"https://www.spreaker.com/show/4488937/episodes/feed\" is the RSS feed URL of the podcast.\n\nIf you want to add a comment or note to yourself in the file, start the line with a `#`. The program will ignore these lines when downloading podcasts. For example:\n\n\n```txt\n# This is my favorite podcast\nModem Prometheus:https://www.spreaker.com/show/5184621/episodes/feed\n```\nOr you can use it to disable a podcast from being downloaded. For example:\n\n```txt\n# This is my favorite podcast\nLost Terminal:https://www.spreaker.com/show/4488937/episodes/feed\n\n# Modem Prometheus:https://www.spreaker.com/show/5184621/episodes/feed\n```\n\nOnce you have prepared your list, save the file. When running the `download_all` command, provide the path to this file:\n\n```shell\nrsspod download_all /path/to/podcast_list.txt\n```\n\nIf no file is provided, the program will look for a file named `podcast_list.txt` in the current directory.\n\n```txt\n#Lost Terminal:https://www.spreaker.com/show/4488937/episodes/feed\nModem Prometheus:https://www.spreaker.com/show/5184621/episodes/feed\n```\n\nIn this example, the \"Lost Terminal\" podcast will not be downloaded because its line starts with #. Each non-comment line represents a separate podcast with its corresponding RSS feed URL. The program will download all episodes from each provided podcast URL.\n\n>Credits to [Tris](https://github.com/0atman) for the best SCI-FI podcast out there [Lost Terminal](https://lostterminal.com/).\n\n---\n\n### Dependencies\nThis program uses the following Python packages:\n\n- `requests`: Used for making HTTP requests to download the podcast episodes.\n- `bs4` (BeautifulSoup): Used for parsing the XML of the RSS feeds.\n- `eyed3`: Used for handling ID3 tags in the downloaded MP3 files.\n- `os` and `argparse`: Used for file operations and command line argument parsing, respectively.\n- `alive_progress`: Used for displaying a progress bar while the podcasts are being downloaded.\n- `io`: Used for handling byte streams.\n- `time`: Used for time-related tasks.\n- `socket`: Used for low-level networking interface.\n- `re`: Used for regular expression operations.\n\nYou can install these packages using pip:\n```shell\npip install requests bs4 eyed3 alive_progress\n```\n\nNote: `os`, `argparse`, `io`, `time`, `socket`, and re are part of the Python standard library, so you don't need to install them separately.\n\n---\n\n### Build Yourself (Optional)\nIf you want to build this project yourself, follow these steps\n\n1. clone the repository\n\n```shell\ngit clone https://github.com/yourusername/RSSPod_dl.git\n```\n\n2. Install the package\n\n```shell\ncd RSSPod_dl\npip install .\n```\n---\n\n## License\nThis program is released under the MIT License. See the `LICENSE` file for more details.\n\n---\n\n## About\n\nThis project was born out of a personal need. As a podcast listener, I wanted a simple way to download my favorite podcasts from various sources and sync them to my iPod. This tool allows me to do just that - it downloads multiple podcasts and organizes them in a single directory, making it easy to transfer and listen to them on my device.\n\nThis is one of my first projects and I'm still learning, so feel free to correct me or suggest improvements, raise issues or contribute to the project!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python CLI tool for downloading and managing podcast from RSS feeds.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/rimaout/RSSPod-dl"
},
"split_keywords": [
"python",
"podcast downloader",
"rss"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7013c3885260ad5ab965c2d3fb754eb83294f88e3d5c4e6bc25f6d18f3469cca",
"md5": "342646e9fddf17f09941f75e286858ac",
"sha256": "8f604f00379e26da28ce01dd060bb7b06f34aa52cf390b3911c5b19aea0e5952"
},
"downloads": -1,
"filename": "RSSPod_dl-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "342646e9fddf17f09941f75e286858ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7207,
"upload_time": "2024-03-01T15:19:44",
"upload_time_iso_8601": "2024-03-01T15:19:44.774987Z",
"url": "https://files.pythonhosted.org/packages/70/13/c3885260ad5ab965c2d3fb754eb83294f88e3d5c4e6bc25f6d18f3469cca/RSSPod_dl-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f0d7def272222d6e2b5dff4ef3acd8d491684f22df58bfbd5ef5b9707652e37",
"md5": "5877fc426e72cbf089d79f8b42619f54",
"sha256": "aab2b2eccfc951935b6257074500a4940e25184e817e9a6bec67322120634ee3"
},
"downloads": -1,
"filename": "RSSPod-dl-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5877fc426e72cbf089d79f8b42619f54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6865,
"upload_time": "2024-03-01T15:19:46",
"upload_time_iso_8601": "2024-03-01T15:19:46.303410Z",
"url": "https://files.pythonhosted.org/packages/7f/0d/7def272222d6e2b5dff4ef3acd8d491684f22df58bfbd5ef5b9707652e37/RSSPod-dl-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 15:19:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rimaout",
"github_project": "RSSPod-dl",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rsspod-dl"
}
JSON
