Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
johnwmillr committed Feb 27, 2018
1 parent b0adb45 commit 474440e
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ This repository is intended to provide an easy interface for programatically acc
To use the Genius API you'll need to sign up for a (free) client that authorizes you to [access their API](http://genius.com/api-clients). You'll need to supply your `client_access_token` from Genius when using this module. See [Usage](https://github.com/johnwmillr/LyricsGenius#usage) below for an example.

## Installation
Python 3.x is required to use this package.

The easiest way to use this package is to install it via [PyPI](https://pypi.python.org/pypi/lyricsgenius) using `pip`:

`$pip install lyricsgenius`
Expand Down Expand Up @@ -54,8 +56,8 @@ Andy Shauf, 4 songs
You can also call the package from the command line. When ran from the command line, the package expects to find an environment variable with your Genius client access token.
```
$export GENIUS_CLIENT_ACCESS_TOKEN="my_client_access_token_here"
$python -m lyricsgenius --search_song 'Begin Again' 'Andy Shauf'
$python -m lyricsgenius --search_artist 'Lupe Fiasco' 3
$python3 -m lyricsgenius --search-song 'Begin Again' 'Andy Shauf'
$python3 -m lyricsgenius --search-artist 'Lupe Fiasco' 3
```

## Example projects
Expand Down
4 changes: 2 additions & 2 deletions lyricsgenius/__main__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Command line usage:
# $python -m lyricsgenius --search_song 'Begin Again' 'Andy Shauf'
# $python -m lyricsgenius --search_artist 'Lupe Fiasco' 3
# $python3 -m lyricsgenius --search-song 'Begin Again' 'Andy Shauf'
# $python3 -m lyricsgenius --search-artist 'Lupe Fiasco' 3

import sys
import os
Expand Down
5 changes: 2 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# http://peterdowns.com/posts/first-time-with-pypi.html
import os
from setuptools import find_packages, setup
# from distutils.core import setup

here = os.path.abspath(os.path.dirname(__file__))
with open(os.path.join(here, 'README.md')) as f:
Expand All @@ -13,7 +12,7 @@

setup(
name='lyricsgenius',
version='0.3',
version='0.4',
description='Download lyrics and metadata from Genius.com',
long_description=README,
classifiers=[
Expand All @@ -22,7 +21,7 @@
author='John W. Miller',
author_email='[email protected]',
url='https://github.com/johnwmillr/lyricsgenius',
download_url = "https://github.com/johnwmillr/LyricsGenius/archive/0.3.tar.gz",
download_url = "https://github.com/johnwmillr/LyricsGenius/archive/0.4.tar.gz",
keywords='genius api music lyrics artists albums songs',
packages=find_packages(),
include_package_data=True,
Expand Down

0 comments on commit 474440e

Please sign in to comment.