Commits

Stefan Scherfke committed c209df1

Started with sphinx documentation and added a quickstart guide.

Comments (0)

Files changed (7)

 ------------
 
 This app is tested with Django 1.1. It might also work with older versions, but
-I haven’t tested it.
+I haven’t tested it. 
+`Setuptools <http://pypi.python.org/pypi/setuptools>`_ is required to install this app.
 
 If you want to run the tests, you’ll need to install `Mock <http://www.voidspace.org.uk/python/mock/>`_.
 
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html      to make standalone HTML files"
+	@echo "  dirhtml   to make HTML files named index.html in directories"
+	@echo "  pickle    to make pickle files"
+	@echo "  json      to make JSON files"
+	@echo "  htmlhelp  to make HTML files and a HTML help project"
+	@echo "  qthelp    to make HTML files and a qthelp project"
+	@echo "  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  changes   to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck to check all external links for integrity"
+	@echo "  doctest   to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/django-lastfm.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/django-lastfm.qhc"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."
+# -*- coding: utf-8 -*-
+#
+# django-lastfm documentation build configuration file, created by
+# sphinx-quickstart on Fri Nov 27 10:35:57 2009.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.txt'
+
+# The encoding of source files.
+#source_encoding = 'utf-8'
+
+# The master toctree document.
+master_doc = 'contents'
+
+# General information about the project.
+project = u'django-lastfm'
+copyright = u'2009, Stefan Scherfke'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_use_modindex = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-lastfmdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('contents', 'django-lastfm.tex', u'django-lastfm Documentation',
+   u'Stefan Scherfke', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_use_modindex = True
+.. django-lastfm documentation master file, created by
+   sphinx-quickstart on Fri Nov 27 10:35:57 2009.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to django-lastfm's documentation!
+=========================================
+
+Contents:
+
+.. toctree::
+    :maxdepth: 2
+   
+    quickstart
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

doc/quickstart.txt

+
+.. _quickstart:
+
+Quickstart Guide
+================
+
+This guide assumes that you already have a `Django
+<http://www.djangoproject.com/>`_ installation up and running. If this is not
+the case, you should work through `Django tutorial
+<http://docs.djangoproject.com/en/dev/intro/install/#intro-install>`_ first.
+
+
+Get a Last.fm API key
+---------------------
+
+In order to use the Last.fm web services, you’ll need an API key. You can get
+one `here <http://www.last.fm/api/account>`_ – it’s free for non-commercial use.
+
+
+Installation
+------------
+
+This app requires `Setuptools <http://pypi.python.org/pypi/setuptools>`_ for
+installation. Optionally, If you want to run the tests, you need to install
+`Mock <http://www.voidspace.org.uk/python/mock/>`_.
+
+You can either `download a stabled version
+<http://bitbucket.org/scherfke/django-lastfm/downloads/>`_ or use the latest
+version from the repository.
+
+If you downloaded the stable version, unpack it and open a terminal. Change to
+the directory that contains django-lastfm’s ``setup.py`` and execute it as
+follows:
+
+.. sourcecode:: bash
+
+    $ cd where/you/put/django-lastfm/
+    $ sudo python setup.py install
+    
+If you want the bleeding edge, clone the repository and install it in
+development mode. This will create just a link in your ``site packages`` that
+points to your local repository:
+
+.. sourcecode:: bash
+
+    $ hg clone hg clone http://bitbucket.org/scherfke/django-lastfm/
+    $ cd django-lastfm/
+    $ sudo python setup.py develop
+
+
+Configuration
+-------------
+
+First you need to add ``'lastfm'`` to your ``INSTALLED_APPS`` within your 
+``settings.py``.
+
+Then add the following variables to your ``settings.py``::
+
+    LASTFM_USER = 'your_lastfm_username'
+    LASTFM_API_KEY = 'your_api_key'
+    # Available types: recent_tracks, weekly_top_artists, top_artists
+    LASTFM_CHART_TYPE = 'top_artists'
+    LASTFM_WIDGET_TITLE = 'Weekly Top Artists'
+    LASTFM_NUM_IMAGES = '12'
+    LASTFM_TOP_ARTISTS_PERIOD = '7day'
+    # Available sizes: small, medium, large, extralarge
+    LASTFM_IMG_SIZE = 'large'
+    
+Most of them should be very self-explanatory. ``LASTFM_TOP_ARTISTS_PERIOD`` is
+only required for the ``top_artist`` chart type.
+
+
+Add the widget to your templates
+--------------------------------
+
+Django-lastfm provides a template tag that inserts the widget to the context
+of your template (e.g. ``base.html``):
+
+.. sourcecode:: html+django
+
+    {% load lastfm_widget %}
+    
+    <!-- ... -->
+    
+    {% get_lastfm_widget as lastfm_widget %}
+    <h2>{{ lastfm_widget.title }}</h2>
+    {{ lastfm_widget.content }}
+    
+    <!-- ... -->
+    
+The template tag ``get_last_widget`` creates a new context variable whose name
+can be chosen as you want (e.g. ``lastfm_widget``). It has two attributes: ``title`` contains the string, that you specified in your ``settings.py``; ``content`` contains a ``<div>`` container and some AJAX code that retrieves the Last.fm data from the corresponding view and creates something like this:
+
+.. sourcecode:: html
+
+    <div class="lastfm">
+        <div><a><img /></a></div>
+        <div><a><img /></a></div>
+        <!-- ... -->
+    </div>
+    
+The surrounding ``<div>`` has the CSS class *lastfm*. You can use this to
+customize the style of the widget. 
+
+.. sourcecode:: css
+
+    #sidebar > #lastfm {
+        min-height: 225px; /* required due to "float: left" in the next sec. */
+    }
+
+    #sidebar #lastfm div {
+        width: 54px;
+        height: 39px;
+        overflow: hidden;
+        float: left;
+        border: 1px solid white;
+        -moz-border-radius: 2px;
+        -khtml-border-radius: 2px;
+        border-radius: 2px;
+        margin: 0px 2px 4px 2px;
+    }
+
+    #sidebar #lastfm div:active, #sidebar #lastfm div:hover {
+        border-color: #9FC765;
+    }
+
+    #sidebar #lastfm img {
+        width: 54px;
+        min-height: 39px;
+    }
+    
+A word on caching
+-----------------
+
+*TODO*
+
+
+Complete!
+---------
+
+Reload your webserver and that’s it!

lastfm/templatetags/lastfm_widget.py

 
 .. sourcecode:: html
 
-    <div>
+    <div class="lastfm">
         <div><a><img /></a></div>
         <div><a><img /></a></div>
         <!-- ... -->
     </div>
 
 The surrounding ``<div>`` has the CSS class *lastfm*. You can use this to
-customize the style of the widget. This could look like this:
+customize the style of the widget. This how it could look like:
 
 .. sourcecode:: css
 
 from django.utils import simplejson as json
 
 
+url = 'http://ws.audioscrobbler.com/2.0/?'
+
+
 def lastfm_data(request):
     """This view retrievs the data from Last.fm and returns a JSON encoded list.         
     The AJAX code from the template tag will retrive this list and generate
     ``get_default_image()``: Return a url to a default image that will be used
     if a track or artist has no image on its own.
     
-    ``get_img_url(url, img_size, item)``: This method needs to be implemented
-    only if an item has no ``image`` key (which is the case for e.g. the weekly
-    top artist). It gets the Last.fm API url, the desired image size (small,
-    medium, large, …) and the item. It might do another API call and extract a
-    custom image URL for that item."""
-    url = 'http://ws.audioscrobbler.com/2.0/?'
+    ``get_img_url(img_size, item)``: This method needs to be implemented only if
+    an item has no ``image`` key (which is the case for e.g. the weekly top
+    artist). It gets the desired image size (small, medium, large, …) and the
+    item. It might do another API call and extract a custom image URL for that
+    item."""
     chart_types = {
         'recent_tracks': RecentTracks,
         'weekly_top_artists': WeeklyTopArtists,
                     item['img_url'] = img['#text']
                     break
         else:
-            item['img_url'] = chart.get_img_url(url, img_size, d)
+            item['img_url'] = chart.get_img_url(img_size, d)
         
         items.append(item)
         
         return 'http://cdn.last.fm/flatness/catalogue/noimage/2/' + \
                 'default_artist_large.png'
 
-    def get_img_url(self, url, img_size, item):
+    def get_img_url(self, img_size, item):
         """A chart item of this class does not contain any images, so we need to 
         do another API call to get an image for artist in ``item``."""
         params = urllib.urlencode({