From 474440ecc92e18ff04fb2ae21b52f2f9b3f1b8fb Mon Sep 17 00:00:00 2001 From: johnwmillr Date: Mon, 26 Feb 2018 22:54:59 -0600 Subject: [PATCH] Update README --- README.md | 6 ++++-- lyricsgenius/__main__.py | 4 ++-- setup.py | 5 ++--- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 41fff4fb..e373d567 100644 --- a/README.md +++ b/README.md @@ -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` @@ -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 diff --git a/lyricsgenius/__main__.py b/lyricsgenius/__main__.py index 850d8787..279b88bf 100644 --- a/lyricsgenius/__main__.py +++ b/lyricsgenius/__main__.py @@ -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 diff --git a/setup.py b/setup.py index 3295814d..0665667b 100644 --- a/setup.py +++ b/setup.py @@ -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: @@ -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=[ @@ -22,7 +21,7 @@ author='John W. Miller', author_email='john.w.millr@gmail.com', 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,