mirror of
https://github.com/cooperhammond/irs.git
synced 2024-12-22 17:35:28 +00:00
updated readme
This commit is contained in:
parent
1b044b615a
commit
aa269830ac
40
README.md
40
README.md
|
@ -1,5 +1,3 @@
|
|||
<div align="center"><img src ="http://i.imgur.com/VbsyTe7.png" /></div>
|
||||
|
||||
# Ironic Redistribution System
|
||||
|
||||
[![License: GNU](https://img.shields.io/badge/license-gnu-yellow.svg?style=flat-square)](http://www.gnu.org/licenses/gpl.html)
|
||||
|
@ -7,8 +5,6 @@
|
|||
[![Say Thanks](https://img.shields.io/badge/say-thanks-ff69b4.svg?style=flat-square)](https://saythanks.io/to/kepoorhampond)
|
||||
[![PyPI](https://img.shields.io/badge/pypi-irs-blue.svg?style=flat-square)](https://pypi.python.org/pypi/irs)
|
||||
|
||||
<sup><sub>(Shields: Gotta Catch Em All)</sub></sup>
|
||||
|
||||
> A music downloader that understands your metadata needs.
|
||||
|
||||
A tool to download your music with metadata. It uses [Spotify](https://www.spotify.com/) for finding metadata and [Youtube](https://www.youtube.com/) for the actual audio source. You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens).
|
||||
|
@ -19,7 +15,6 @@ Works with Python 2 and 3.
|
|||
```
|
||||
$ sudo pip install irs
|
||||
$ irs --setup
|
||||
$ pip install youtube_dl # Only if on windows
|
||||
```
|
||||
|
||||
**You will need to have some Spotify tokens, the instructions to set them up are [here](https://github.com/kepoorhampond/irs#spotify-tokens).**
|
||||
|
@ -27,30 +22,29 @@ $ pip install youtube_dl # Only if on windows
|
|||
|
||||
## Demo and Usages
|
||||
|
||||
This is a demo of the CLI displayling its features:
|
||||
[![demo](https://asciinema.org/a/105993.png)](https://asciinema.org/a/105993?autoplay=1)
|
||||
|
||||
The usages can be found with the `-h` or `--help` flag:
|
||||
```
|
||||
usage: irs [-h] [-a ARTIST -s SONG] [-A ALBUM [-a ARTIST]]
|
||||
[-u USERNAME -p PLAYLIST] [-l LOCATION] [-o] [-c]
|
||||
usage: irs [-h] [-S] [-a ARTIST] [-s SONG] [-A ALBUM] [-p PLAYLIST]
|
||||
[-u USERNAME] [-o ORGANIZATION]
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-S, --setup Run this by itself to setup config files and folder
|
||||
for irs and download the ffmpeg binaries
|
||||
-a ARTIST, --artist ARTIST
|
||||
Specify artist name. Must be used with -s/--song or
|
||||
-A/--album
|
||||
-s SONG, --song SONG Specify song name. Must be used with -a/--artist
|
||||
-A ALBUM, --album ALBUM
|
||||
Specify album name
|
||||
-u USERNAME, --username USERNAME
|
||||
Specify username. Must be used with -p/--playlist
|
||||
Specify album name. Can be used by itself.
|
||||
-p PLAYLIST, --playlist PLAYLIST
|
||||
Specify playlist name. Must be used with -u/--username
|
||||
-l LOCATION, --location LOCATION
|
||||
Specify a directory to place files in.
|
||||
-o, --organize Organize downloaded files.
|
||||
-c, --config Display path to config file.
|
||||
Specify playlist name. Must be used with -A/--album
|
||||
-u USERNAME, --username USERNAME
|
||||
Specify user name for playlist. Must be used with
|
||||
-A/--album
|
||||
-o ORGANIZATION, --organization ORGANIZATION
|
||||
Specify type of organization for list. Used when
|
||||
downloading spotify playlist/album
|
||||
```
|
||||
|
||||
So all of these are valid commands:
|
||||
|
@ -79,19 +73,13 @@ Currently, the program attaches the following metadata to the downloaded files:
|
|||
- Genre
|
||||
- Track Number
|
||||
- Disc Number
|
||||
- Compilation (iTunes only)
|
||||
|
||||
## Philosophy
|
||||
|
||||
When I made this program I was pretty much broke and my music addiction wasn't really helping that problem. So, I did the obvious thing: make an uber-complicated program to ~~steal~~ download music for me! As for the name, its acronym spells IRS, which I found amusing, seeing as the IRS ~~takes~~ steals money while my program ~~gives~~ reimburses you with music.
|
||||
|
||||
The design/style inspiration of the CLI goes to [k4m4](https://github.com/k4m4).
|
||||
|
||||
## Wishlist
|
||||
|
||||
- [x] Full album downloading
|
||||
- [x] Album art metadata correctly displayed
|
||||
- [x] Spotify playlist downloading
|
||||
- [ ] Comment metadata
|
||||
- [ ] Compilation metadata
|
||||
- [ ] GUI/Console interactive version - *in progress*
|
||||
- [ ] Lyric metadata
|
||||
- [ ] 99% success rate for automatic song choosing
|
||||
|
|
Loading…
Reference in a new issue