Hirad/pylast
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Merge pull request #96 from kiliankoe/master

Browse source 
syntax highlighting in readme [CI skip]
This commit is contained in:
Hugo 2014-08-20 12:57:35 +03:00
parent 862ae11cfa 0058c8b832
commit f2b0237d61
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -36,7 +36,7 @@ Getting Started
Here's a simple code example to get you started. In order to create any object from pyLast, you need a Network object which represents a social music network that is Last.fm or any other API-compatible one. You can obtain a pre-configured one for Last.fm and use it as follows: Here's a simple code example to get you started. In order to create any object from pyLast, you need a Network object which represents a social music network that is Last.fm or any other API-compatible one. You can obtain a pre-configured one for Last.fm and use it as follows:
``` ```python
import pylast import pylast
# You have to have your own unique two values for API_KEY and API_SECRET # You have to have your own unique two values for API_KEY and API_SECRET
@ -73,7 +73,7 @@ Testing
You need a test account at Last.fm that will be cluttered with test data, and an API key and secret. Either copy [example_test_pylast.yaml](example_test_pylast.yaml) to test_pylast.yaml and fill out the credentials, or set them as environment variables like: You need a test account at Last.fm that will be cluttered with test data, and an API key and secret. Either copy [example_test_pylast.yaml](example_test_pylast.yaml) to test_pylast.yaml and fill out the credentials, or set them as environment variables like:
``` ```sh
export PYLAST_USERNAME=TODO_ENTER_YOURS_HERE export PYLAST_USERNAME=TODO_ENTER_YOURS_HERE
export PYLAST_PASSWORD_HASH=TODO_ENTER_YOURS_HERE export PYLAST_PASSWORD_HASH=TODO_ENTER_YOURS_HERE
export PYLAST_API_KEY=TODO_ENTER_YOURS_HERE export PYLAST_API_KEY=TODO_ENTER_YOURS_HERE
@ -81,23 +81,23 @@ export PYLAST_API_SECRET=TODO_ENTER_YOURS_HERE
``` ```
To run all: To run all:
``` ```sh
pip install -r test_requirements.txt pip install -r test_requirements.txt
./test_pylast.py ./test_pylast.py
``` ```
Or run just one: Or run just one:
``` ```sh
./test_pylast.py -1 test_scrobble ./test_pylast.py -1 test_scrobble
``` ```
Or all those tests matching a term: Or all those tests matching a term:
``` ```sh
./test_pylast.py -m geo ./test_pylast.py -m geo
``` ```
To run with coverage: To run with coverage:
``` ```sh
coverage run --source=pylast ./test_pylast.py coverage run --source=pylast ./test_pylast.py
coverage report # for command-line report coverage report # for command-line report
coverage html # for HTML report coverage html # for HTML report
@ -105,6 +105,6 @@ open htmlcov/index.html
``` ```
To perform some static analysis: To perform some static analysis:
``` ```sh
./check.sh ./check.sh
``` ```