1
0
mirror of https://github.com/obskyr/khinsider.git synced 2025-09-03 01:52:33 +02:00

Merge pull request #12 from rogersachan/patch-1

Lint markdown
This commit is contained in:
obskyr
2017-07-07 18:09:57 +02:00
committed by GitHub

View File

@@ -1,12 +1,15 @@
#khinsider.py
# khinsider.py
`khinsider.py` is a [Python](https://www.python.org/) interface for getting [khinsider](http://downloads.khinsider.com/) soundtracks. It makes khinsider mass downloads a breeze. It's easy to use - check it!
From command line:
```
```cmd
khinsider.py jumping-flash
```
As an import:
```python
import khinsider
khinsider.download('jumping-flash')
@@ -18,6 +21,7 @@ For anime music, [check out `thehylia.py`](https://github.com/obskyr/thehylia).
Carefully put together by [@obskyr](http://twitter.com/obskyr)!
## Usage
Just run `khinsider.py` from the command line with the sole parameter being the soundtrack you want to download. Easy!
If you want, you can also add another parameter as the output folder, but that's optional.
@@ -31,19 +35,23 @@ You will also need to have [pip](https://pip.readthedocs.org/en/latest/installin
Download for `khinsider.py` is on the right of this GitHub page - click "Download ZIP"!
## As a module
`khinsider.py` requires two non-standard modules: [requests](https://pypi.python.org/pypi/requests) and [beautifulsoup4](https://pypi.python.org/pypi/beautifulsoup4). Just run a `pip install` on them (with [pip](https://pip.readthedocs.org/en/latest/installing.html)), or just run `khinsider.py` on its own once and it'll install them for you.
Here are the functions you will be using:
###`khinsider.download(soundtrackName[, path="", verbose=False])`
### `khinsider.download(soundtrackName[, path="", verbose=False])`
Download the soundtrack `soundtrackName`. This should be the name the soundtrack uses at the end of its album URL.
If `path` is specified, the soundtrack files will be downloaded to that path. If `verbose` is `True`, it will print progress as it is downloading.
###`khinsider.search(term)`
### `khinsider.search(term)`
Search khinsider for `term`. Return a list of soundtrack IDs matching the search term.
# Talk to me!
## Talk to me!
You can easily get to me by:
* [@obskyr](http://twitter.com/obskyr/) on Twitter!