mirror of
https://github.com/cooperhammond/irs.git
synced 2025-07-04 15:28:14 +00:00
Updated README.md
This commit is contained in:
parent
01e36b2a78
commit
fb09be845d
|
@ -5,6 +5,9 @@ python:
|
||||||
|
|
||||||
before_script:
|
before_script:
|
||||||
- sudo aptitude -y -q install ffmpeg libavcodec-extra-53 lame libmp3lame0
|
- sudo aptitude -y -q install ffmpeg libavcodec-extra-53 lame libmp3lame0
|
||||||
|
# These dependencies are necessary for ffmpeg. I currently hate all things
|
||||||
|
# doing with Travis and ffmpeg because I have no direct access to test stuff.
|
||||||
|
# I've gone through 25 seperate commits to get it working.
|
||||||
|
|
||||||
install:
|
install:
|
||||||
- pip install irs
|
- pip install irs
|
||||||
|
|
21
README.md
21
README.md
|
@ -1,5 +1,4 @@
|
||||||
[](http://i.imgur.com/VbsyTe7.png)
|
<div style="text-align:center"><img src ="http://i.imgur.com/VbsyTe7.png" /></div>
|
||||||
|
|
||||||
Ironic Redistribution System
|
Ironic Redistribution System
|
||||||
===
|
===
|
||||||
[](http://www.gnu.org/licenses/gpl.html)
|
[](http://www.gnu.org/licenses/gpl.html)
|
||||||
|
@ -46,6 +45,23 @@ $ irs -s "Bohemian Rhapsody"
|
||||||
$ irs -p "Best Nirvana"
|
$ irs -p "Best Nirvana"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Install & The Dependencies <sub><sup>(my new band name)</sub></sup>
|
||||||
|
---
|
||||||
|
Really there's only one actual external dependency: `ffmpeg`. For windows, you'll want to follow [this](http://www.wikihow.com/Install-FFmpeg-on-Windows) guide. For OSX, you'll want to install it through [`brew`](https://brew.sh/) with this command:
|
||||||
|
```
|
||||||
|
$ brew install ffmpeg
|
||||||
|
```
|
||||||
|
For Linux, most package managers have `ffmpeg` in their default repositories, so it can be installed like so:
|
||||||
|
```
|
||||||
|
$ sudo apt-get install ffmpeg
|
||||||
|
```
|
||||||
|
Or whatever your appropriate package manager is.
|
||||||
|
|
||||||
|
Other than `ffmpeg` though, all other dependencies are automatically installed with [`pip`](https://pip.pypa.io/en/stable/):
|
||||||
|
```
|
||||||
|
$ sudo pip install irss
|
||||||
|
```
|
||||||
|
|
||||||
Metadata
|
Metadata
|
||||||
---
|
---
|
||||||
Currently, the program attaches the following metadata to the downloaded files:
|
Currently, the program attaches the following metadata to the downloaded files:
|
||||||
|
@ -62,7 +78,6 @@ Currently, the program attaches the following metadata to the downloaded files:
|
||||||
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.
|
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.
|
||||||
|
|
||||||
### Wishlist
|
### Wishlist
|
||||||
- [x] Finds album based off of song name and artist
|
|
||||||
- [x] Full album downloading
|
- [x] Full album downloading
|
||||||
- [x] Album art metadata correctly displayed
|
- [x] Album art metadata correctly displayed
|
||||||
- [x] Spotify playlist downloading
|
- [x] Spotify playlist downloading
|
||||||
|
|
1
setup.py
1
setup.py
|
@ -15,7 +15,6 @@ setup(
|
||||||
'youtube-dl',
|
'youtube-dl',
|
||||||
'requests',
|
'requests',
|
||||||
'spotipy',
|
'spotipy',
|
||||||
'ffprobe',
|
|
||||||
],
|
],
|
||||||
entry_points = {
|
entry_points = {
|
||||||
'console_scripts': ['irs = irs.cli:main'],
|
'console_scripts': ['irs = irs.cli:main'],
|
||||||
|
|
2
tests/tests_readme.md
Normal file
2
tests/tests_readme.md
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
# Travis CI tests are wierd
|
||||||
|
Tests with `ffmpeg` are wierd on Travis. It's a fact that I've had to deal with for 25 commits in total. So, the only songs I've found *so far* that work with ffmpeg are from the album `Da Frame 2R / Matador` by `Arctic Monkeys`. It's really lame, but don't mess around with them.
|
Loading…
Reference in a new issue