mirrors/streamrip
1
0
Fork 0
mirror of https://github.com/nathom/streamrip.git synced 2025-05-09 14:11:55 -04:00
Code Issues Projects Releases Packages Wiki Activity

Move stuff from README to wiki

Browse source
This commit is contained in:
nathom 2021-05-13 22:52:34 -07:00
parent f0aa020b3d
commit 5f6a19f6ff
1 changed files with 3 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

82
README.md
View file

@ -122,83 +122,9 @@ rip discover --list 'best-sellers'
> - universal-jeunesse
> - universal-chanson
## The Config File
## Other information
This is where most of streamrip's functionality can be controlled. Here are
the descriptions of the fields. They can also be found inside the file, which
can be accessed with `rip config --open`.
```yaml
qobuz:
quality: '1: 320kbps MP3, 2: 16/44.1, 3: 24/<=96, 4: 24/>=96'
download_booklets: 'This will download booklet pdfs that are included with some albums'
password: 'This is an md5 hash of the plaintext password'
app_id: 'Do not change'
secrets: 'Do not change'
tidal:
quality: '0: 256kbps AAC, 1: 320kbps AAC, 2: 16/44.1 "HiFi" FLAC, 3: 24/44.1 "MQA" FLAC'
download_videos: 'This will download videos included in Video Albums.'
user_id: 'Do not change any of the fields below'
token_expiry: 'Tokens last 1 week after refresh. This is the Unix timestamp of the expiration time.'
deezer: "Deezer doesn't require login"
quality: '0, 1, or 2'
soundcloud:
quality: 'Only 0 is available'
database: 'This stores a list of item IDs so that repeats are not downloaded.'
filters: "Filter a Qobuz artist's discography. Set to 'true' to turn on a filter."
extras: 'Remove Collectors Editions, live recordings, etc.'
repeats: 'Picks the highest quality out of albums with identical titles.'
non_albums: 'Remove EPs and Singles'
features: 'Remove albums whose artist is not the one requested'
non_remaster: 'Only download remastered albums'
downloads:
folder: 'Folder where tracks are downloaded to'
source_subdirectories: "Put Qobuz albums in a 'Qobuz' folder, Tidal albums in 'Tidal' etc."
artwork:
embed: 'Write the image to the audio file'
size: "The size of the artwork to embed. Options: thumbnail, small, large, original. 'original' images can be up to 30MB, and may fail embedding. Using 'large' is recommended."
keep_hires_cover: 'Save the cover image at the highest quality as a seperate jpg file'
metadata: 'Only applicable for playlist downloads.'
set_playlist_to_album: "Sets the value of the 'ALBUM' field in the metadata to the playlist's name. This is useful if your music library software organizes tracks based on album name."
new_playlist_tracknumbers: "Replaces the original track's tracknumber with it's position in the playlist"
path_format: 'Changes the folder and file names generated by streamrip.'
folder: 'Available keys: "albumartist", "title", "year", "bit_depth", "sampling_rate", and "container"'
track: 'Available keys: "tracknumber", "artist", "albumartist", "composer", and "title"'
lastfm: 'Last.fm playlists are downloaded by searching for the titles of the tracks'
source: 'The source on which to search for the tracks.'
concurrent_downloads: 'Download (and convert) tracks all at once, instead of sequentially. If you are converting the tracks, and/or have fast internet, this will substantially improve processing speed.'
```
## Integration with macOS Music app
`streamrip` was designed to be used seamlessly with the macOS Music app. To set it up, you need to find the `Automatically Add to Music.localized` folder inside the file given at `Music.app -> Preferences -> Files -> Music Media folder location`. Set the downloads folder to the path in the config file.
Next, enable `conversion` and set the `codec` to `alac`. If you want to save space, set `sampling_rate` to `48000`. Finally, set `keep_hires_cover` to `false`.
Now, you can download anything and it will appear in your Library!
## Troubleshooting
If you're getting an error that looks something like `command not found: rip`, make sure the location of the `rip` executable is on the `$PATH` (`PATH` for Windows) environment variable.
If you're having other issues with the tool, try the following:
- Consult the help pages and their example commands.
```bash
rip --help
rip filter --help
rip search --help
rip discover --help
rip config --help
rip lastfm --help
```
- Update `streamrip` with by running `pip3 install streamrip --upgrade`
- Reset the config file with `rip config --reset`
If none of the above work, open an [issue](#guidelines-for-opening-issues).
For more in-depth information about `streamrip`, see the [wiki](https://github.com/nathom/streamrip/wiki/).
## Contributions
@ -229,8 +155,6 @@ Please document any functions or obscure lines of code.
Thanks to Vitiko98, Sorrow446, and DashLt for their contributions to this project, and the previous projects that made this one possible.
`streamrip` was inspired by:
- [qobuz-dl](https://github.com/vitiko98/qobuz-dl)
@ -243,4 +167,4 @@ Thanks to Vitiko98, Sorrow446, and DashLt for their contributions to this projec
## Disclaimer
I will not be responsible for how you use `streamrip`. By using `streamrip`, you agree to the terms and conditions of the Qobuz, Tidal, and Deezer APIs.
I will not be responsible for how you use `streamrip`. By using `streamrip`, you agree to the terms and conditions of the Qobuz, Tidal, and Deezer APIs.