django-lastfm / README.txt

Django Last.fm access
=====================

This is a small Django application that allows you to access Last.fm and
embed e.g. your recently listened tracks or you top artists on your website.

Currently you can get your

* recently listened tracks
* weekly artist chart
* top artists (for a definable period)

The application consists of two main parts: The first one is a view, that
retrieves the data from Last.fm, processes it and returns it as a JSON encoded
dict. The second one is a template tag that embeds some AJAX code into your
website. This code will call the view and display the artist images or album
covers. This mechanism prevents the Last.fm servers from slowing down your
blazingly fast Django site … ;-)


Requirements
------------

This app is tested with Django 1.1. It might also work with older versions, but
I haven’t tested it.

If you want to run the tests, you’ll need to install `Mock 
<http://www.voidspace.org.uk/python/mock/>`_.

There are no other requirements.


Installation
------------

If you read this, you have probably managed to extract the archive containing
these files. Next, open a Terminal and `cd` to the directory containing this
file (e.g. ``cd ~/Downloads/django-lastfm``). Then execute::

    python setup.py install
    
If you checked out the repository and always want to use the newest version,
type::

    pip install -e path/to/django-lastfm
    

Usage
-----

The Documentation can be found in the *docs/* directory or
`online <http://stefan.sofa-rockers.org/docs/django-lastfm/>`_.
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.