Wrote out the new README

This commit is contained in:
Kepoor Hampond 2016-12-10 16:26:11 -08:00
parent db64eaa823
commit 2bb464a201
2 changed files with 23 additions and 40 deletions

View file

@ -1,43 +1,26 @@
# Ingenious Redistribution System <sub><sup>v2.0<sup><sub>
# Ingenious Redistribution System
[![License: GNU](https://img.shields.io/badge/License-GNU-yellow.svg)](http://www.gnu.org/licenses/gpl.html)
[![PyPI](https://img.shields.io/badge/Python-3.5-blue.svg)](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
```
[![asciicast](https://asciinema.org/a/bcs7i0sjmka052wsdyxg5xrug.png)](https://asciinema.org/a/bcs7i0sjmka052wsdyxg5xrug?speed=3&autoplay=true)
___
### Installation
```
$ pip install irs
```

View file

@ -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',