mirror of
https://github.com/cooperhammond/irs.git
synced 2025-02-27 23:16:46 +00:00
Wrote out the new README
This commit is contained in:
parent
db64eaa823
commit
2bb464a201
61
README.md
61
README.md
|
@ -1,43 +1,26 @@
|
|||
# Ingenious Redistribution System <sub><sup>v2.0<sup><sub>
|
||||
# Ingenious Redistribution System
|
||||
[](http://www.gnu.org/licenses/gpl.html)
|
||||
[](https://pypi.python.org/pypi/irs)
|
||||
|
||||
An "ingenious" program to download music and then parse metadata for the downloaded file.
|
||||
<em>Now with working album art!<em>
|
||||
|
||||
## Examples
|
||||
|
||||
To download the Arctic Monkeys' album AM, you would type `$ irs album AM by Arctic Monkeys`
|
||||
To download a single song you would do `$ irs song Should I Stay Or Should I Go by The Clash`
|
||||
|
||||
## Installation/Dependencies
|
||||
|
||||
First, actually install python and pip:
|
||||
- To install python3 and `pip` for Ubuntu run this command:
|
||||
|
||||
```bash
|
||||
$ sudo apt-get install python3 python3-pip
|
||||
```
|
||||
- For Windows follow [this](http://www.howtogeek.com/197947/how-to-install-python-on-windows/) guide to install python (remember to install ~v3.4), and [this](https://pip.pypa.io/en/latest/installing/) guide to install `pip`.
|
||||
- For OSX follow [this](http://docs.python-guide.org/en/latest/starting/install/osx/) guide that goes through python and `pip`. Also, remember to install ~v3.4.
|
||||
|
||||
Then install `requirements.txt` from the repository:
|
||||
```bash
|
||||
$ pip install -r requirements.txt
|
||||
An ingenious program to download audio from youtube and then parse metadata for the downloaded file.
|
||||
___
|
||||
### Usage and Examples
|
||||
```
|
||||
And you should be good to just run `irs.py`!
|
||||
usage: irs [-h] [-a ARTIST] [-A ALBUM | -s SONG]
|
||||
|
||||
## License
|
||||
Ingenious Redistribution System, A system built to redistribute media to the consumer.
|
||||
|
||||
Copyright (C) 2016 Cooper Hammond
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-a ARTIST, --artist ARTIST
|
||||
Specify the artist name
|
||||
-A ALBUM, --album ALBUM
|
||||
Specify album name of the artist
|
||||
-s SONG, --song SONG Specify song name of the artist
|
||||
```
|
||||
[](https://asciinema.org/a/bcs7i0sjmka052wsdyxg5xrug?speed=3&autoplay=true)
|
||||
___
|
||||
### Installation
|
||||
```
|
||||
$ pip install irs
|
||||
```
|
||||
|
|
2
setup.py
2
setup.py
|
@ -3,7 +3,7 @@ from setuptools import setup
|
|||
setup(
|
||||
name='irs',
|
||||
version='0.1',
|
||||
description='A music downloader that gets metadata.',
|
||||
description='A music downloader that just gets metadata.',
|
||||
url='http://github.com/kepoorhampond/irs',
|
||||
author='Kepoor Hampond',
|
||||
author_email='kepoorh@gmail.com',
|
||||
|
|
Loading…
Reference in a new issue