# BeatStarsDownloader
Python script for downloading all tracks from a beatstars artist track page.
It functions as a BeatStars downloader to mp3.
Fork from [pyscrapetrain](https://github.com/tim-morriss/pyscrapeTrain).
# Setup
There are two ways to run this tool, either using the pip package or manuall installing the tool.
Pip package method is preferred, only resort to using the manual install if you're having issues.
## Pip Package
Install the pip package, using this command:
```bash
pip install beatstarsdownloader
```
## Manual install
First clone this repo, then install the `requirements.txt` file by using the following command:
```bash
pip install -r requirements.txt
```
Then run the tool using this command:
```bash
python main.py
```
*For the rest of the readme, make sure to swap out the `beatstarsdownloader` command for `python main.py`.*
# How to use:
## Terminal interface
Feel free to use the built in terminal interface to download tracks from a single URL / artist name:
```bash
beatstarsdownloader
```
## CLI interface
**When inputting a url make sure to use the artist's /tracks page.**
**For example: `https://www.beatstars.com/lovbug/tracks`**
----
To download all the tracks from a profile run the following command:
```bash
beatstarsdownloader <beatstars tracks url or artist name>
```
For example:
```bash
beatstarsdownloader https://www.beatstars.com/lovbug/tracks
```
OR
```bash
beatstarsdownloader lovbug
```
Tracks are downloaded to a `beatstarsDownloader/artist` folder in your home directory.
## Changing folder
To change download folder use the `-d` flag:
```bash
beatstarsdownloader <beatstars-url> -d /path/to/folder
```
Which will create a `beatstarsDownloader/artist` folder under the path specified.
For example:
```bash
beatstarsdownloader https://www.beatstars.com/lovbug/tracks -d /Users/user/Documents
```
Will create the following folder `/Users/user/Documents/beatstarsDownloader/lovbug`.
## Adding custom album
You might want to listen to the playlist of tracks you just downloaded
so the script supports a custom album ID3 tag to allow you to sort in your media library.
Use the `-a` tag to assign a custom album name.
For example:
```bash
beatstarsdownloader https://www.beatstars.com/lovbug/tracks -a "bs lovbug"
```
Which gives:
## Supplying a list of URLs
If you want to scrape multiple beatstars pages then you can point a .txt file
with each url you want to scrape on a new line.
For this use-case simply specify the filepath instead of a url.
For example:
```bash
beatstarsdownloader example_url_list.txt
```
Example list of urls:
# Disclaimer
**THIS TOOL IS STRICTLY FOR EDUCATIONAL PURPOSES ONLY.**
**THE AUTHOR TAKES NO RESPONSIBILITY FOR THE USAGE OF THIS TOOL.**
Disclaimer: Use of BeatstarsDownloader (this tool)
This tool, BeatstarsDownloader, is provided to you as a convenience of downloading web assets. Before using this tool, it is important to understand and acknowledge the following:
**Copyrighted Material**: The Author (referring to the author of this code) does not endorse or encourage the unauthorized downloading or distribution of copyrighted music. This tool is intended for use with music that you have the legal right to download and distribute.
**User Responsibility**: The user acknowledges and agrees that they are solely responsible for ensuring that their use of BeatstarsDownloader complies with applicable copyright laws and regulations. Users must obtain the necessary permissions or licenses before downloading and using copyrighted material.
**Legal Compliance**: The Author is not responsible for any legal consequences that may arise from the use of this tool for downloading copyrighted music without the proper authorization. Users should be aware of and comply with the copyright laws in their jurisdiction.
**No Warranty**: The Author provides this tool "as is" without any warranty of any kind, expressed or implied. The Author makes no representations or warranties regarding the accuracy, reliability, or completeness of the tool.
**Updates and Changes**: The Author reserves the right to make changes or updates to this tool at any time without notice. It is the user's responsibility to ensure they are using the latest version of the tool.
By using BeatstarsDownloader, you agree to the terms and conditions outlined in this disclaimer. If you do not agree with these terms, you should not use the tool.
Raw data
{
"_id": null,
"home_page": "https://github.com/tim-morriss/beatstarsdownloader",
"name": "beatstarsdownloader",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "beatstars,downloader",
"author": "Tim Morriss",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/dd/81/c90e350104a2894afa8b7a8a8c510b15dd6ae9315db61bc5dd3ae2da588e/beatstarsdownloader-0.1.0.tar.gz",
"platform": null,
"description": "# BeatStarsDownloader\n\nPython script for downloading all tracks from a beatstars artist track page. \nIt functions as a BeatStars downloader to mp3.\n\nFork from [pyscrapetrain](https://github.com/tim-morriss/pyscrapeTrain).\n\n# Setup\nThere are two ways to run this tool, either using the pip package or manuall installing the tool.\n\nPip package method is preferred, only resort to using the manual install if you're having issues.\n## Pip Package\n\nInstall the pip package, using this command:\n\n```bash\npip install beatstarsdownloader\n```\n\n## Manual install\nFirst clone this repo, then install the `requirements.txt` file by using the following command:\n\n```bash\npip install -r requirements.txt\n```\n\nThen run the tool using this command:\n\n```bash\npython main.py\n```\n\n*For the rest of the readme, make sure to swap out the `beatstarsdownloader` command for `python main.py`.*\n\n# How to use:\n## Terminal interface\nFeel free to use the built in terminal interface to download tracks from a single URL / artist name:\n\n```bash\nbeatstarsdownloader\n```\n\n\n\n## CLI interface\n\n**When inputting a url make sure to use the artist's /tracks page.**\n\n**For example: `https://www.beatstars.com/lovbug/tracks`**\n\n----\n\nTo download all the tracks from a profile run the following command:\n\n```bash\nbeatstarsdownloader <beatstars tracks url or artist name>\n```\n\nFor example: \n```bash\nbeatstarsdownloader https://www.beatstars.com/lovbug/tracks\n```\nOR\n```bash\nbeatstarsdownloader lovbug\n```\n\nTracks are downloaded to a `beatstarsDownloader/artist` folder in your home directory. \n## Changing folder\nTo change download folder use the `-d` flag:\n```bash\nbeatstarsdownloader <beatstars-url> -d /path/to/folder\n```\n\nWhich will create a `beatstarsDownloader/artist` folder under the path specified.\nFor example:\n```bash\nbeatstarsdownloader https://www.beatstars.com/lovbug/tracks -d /Users/user/Documents\n```\nWill create the following folder `/Users/user/Documents/beatstarsDownloader/lovbug`.\n\n## Adding custom album\nYou might want to listen to the playlist of tracks you just downloaded \nso the script supports a custom album ID3 tag to allow you to sort in your media library.\n\nUse the `-a` tag to assign a custom album name.\n\nFor example:\n```bash\nbeatstarsdownloader https://www.beatstars.com/lovbug/tracks -a \"bs lovbug\"\n```\n\nWhich gives:\n\n\n## Supplying a list of URLs\n\nIf you want to scrape multiple beatstars pages then you can point a .txt file \nwith each url you want to scrape on a new line.\n\nFor this use-case simply specify the filepath instead of a url.\n\nFor example:\n```bash\nbeatstarsdownloader example_url_list.txt\n```\n\nExample list of urls:\n\n\n# Disclaimer\n\n**THIS TOOL IS STRICTLY FOR EDUCATIONAL PURPOSES ONLY.**\n\n**THE AUTHOR TAKES NO RESPONSIBILITY FOR THE USAGE OF THIS TOOL.**\n\nDisclaimer: Use of BeatstarsDownloader (this tool)\n\nThis tool, BeatstarsDownloader, is provided to you as a convenience of downloading web assets. Before using this tool, it is important to understand and acknowledge the following:\n\n**Copyrighted Material**: The Author (referring to the author of this code) does not endorse or encourage the unauthorized downloading or distribution of copyrighted music. This tool is intended for use with music that you have the legal right to download and distribute.\n\n**User Responsibility**: The user acknowledges and agrees that they are solely responsible for ensuring that their use of BeatstarsDownloader complies with applicable copyright laws and regulations. Users must obtain the necessary permissions or licenses before downloading and using copyrighted material.\n\n**Legal Compliance**: The Author is not responsible for any legal consequences that may arise from the use of this tool for downloading copyrighted music without the proper authorization. Users should be aware of and comply with the copyright laws in their jurisdiction.\n\n**No Warranty**: The Author provides this tool \"as is\" without any warranty of any kind, expressed or implied. The Author makes no representations or warranties regarding the accuracy, reliability, or completeness of the tool.\n\n**Updates and Changes**: The Author reserves the right to make changes or updates to this tool at any time without notice. It is the user's responsibility to ensure they are using the latest version of the tool.\n\nBy using BeatstarsDownloader, you agree to the terms and conditions outlined in this disclaimer. If you do not agree with these terms, you should not use the tool.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI for downloading BeatStars tracks",
"version": "0.1.0",
"project_urls": {
"Download": "https://github.com/tim-morriss/beatstarsdownloader/archive/refs/tags/v0.1.0.tar.gz",
"Homepage": "https://github.com/tim-morriss/beatstarsdownloader"
},
"split_keywords": [
"beatstars",
"downloader"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "33c63e58c5d63ba9dcf76b35c1d373dfa8a21c7b7b1e52a93cbcd31b1f19c810",
"md5": "538de815eaeb710e820fb62a2535e4a2",
"sha256": "61a080723e7ca859cdb319e6e6283ee3b180e3b5c052b5eb8573f195a100f7bc"
},
"downloads": -1,
"filename": "beatstarsdownloader-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "538de815eaeb710e820fb62a2535e4a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11022,
"upload_time": "2023-12-29T10:27:36",
"upload_time_iso_8601": "2023-12-29T10:27:36.505222Z",
"url": "https://files.pythonhosted.org/packages/33/c6/3e58c5d63ba9dcf76b35c1d373dfa8a21c7b7b1e52a93cbcd31b1f19c810/beatstarsdownloader-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd81c90e350104a2894afa8b7a8a8c510b15dd6ae9315db61bc5dd3ae2da588e",
"md5": "25003abdb5bf5af78ffdf22373750151",
"sha256": "76be169c28c8179f728ed27c3dc81c4f762159e64ea66d88c00e2b12aa14d4c2"
},
"downloads": -1,
"filename": "beatstarsdownloader-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "25003abdb5bf5af78ffdf22373750151",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11784,
"upload_time": "2023-12-29T10:27:38",
"upload_time_iso_8601": "2023-12-29T10:27:38.360836Z",
"url": "https://files.pythonhosted.org/packages/dd/81/c90e350104a2894afa8b7a8a8c510b15dd6ae9315db61bc5dd3ae2da588e/beatstarsdownloader-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-29 10:27:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tim-morriss",
"github_project": "beatstarsdownloader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "beatstarsdownloader"
}
JSON
