[Pkg-mpd-commits] [python-mpd] 197/262: first build of sphinx docs
Simon McVittie
smcv at debian.org
Sun May 22 18:16:46 UTC 2016
This is an automated email from the git hooks/post-receive script.
smcv pushed a commit to branch upstream
in repository python-mpd.
commit e638e5488fbc39ef9e64091af03bd635bf56bf82
Author: mafro <github at mafro.net>
Date: Thu Apr 4 10:30:27 2013 +1100
first build of sphinx docs
---
.gitignore | 3 +
doc/Makefile | 177 +++++++++++++++++++++++++++++
doc/conf.py | 248 +++++++++++++++++++++++++++++++++++++++++
doc/index.rst | 50 +++++++++
doc/topics/advanced.rst | 67 +++++++++++
doc/topics/getting-started.rst | 69 ++++++++++++
doc/topics/logging.rst | 15 +++
7 files changed, 629 insertions(+)
diff --git a/.gitignore b/.gitignore
index dafb4dd..f2406fa 100644
--- a/.gitignore
+++ b/.gitignore
@@ -22,3 +22,6 @@ pip-log.txt
.coverage
.tox
nosetests.xml
+
+# Sphinx docs
+doc/_build
diff --git a/doc/Makefile b/doc/Makefile
new file mode 100644
index 0000000..d2807dd
--- /dev/null
+++ b/doc/Makefile
@@ -0,0 +1,177 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
+endif
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+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 " singlehtml to make a single large HTML file"
+ @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 " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " texinfo to make Texinfo files"
+ @echo " info to make Texinfo files and run them through makeinfo"
+ @echo " gettext to make PO message catalogs"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " xml to make Docutils-native XML files"
+ @echo " pseudoxml to make pseudoxml-XML files for display purposes"
+ @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."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+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/python-mpd2.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-mpd2.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/python-mpd2"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-mpd2"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+latexpdfja:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through platex and dvipdfmx..."
+ $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo
+ @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+ @echo "Run \`make' in that directory to run these through makeinfo" \
+ "(use \`make info' here to do that automatically)."
+
+info:
+ $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+ @echo "Running Texinfo files through makeinfo..."
+ make -C $(BUILDDIR)/texinfo info
+ @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+ $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+ @echo
+ @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+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."
+
+xml:
+ $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
+ @echo
+ @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
+
+pseudoxml:
+ $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
+ @echo
+ @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
diff --git a/doc/conf.py b/doc/conf.py
new file mode 100644
index 0000000..e3e13cd
--- /dev/null
+++ b/doc/conf.py
@@ -0,0 +1,248 @@
+# -*- coding: utf-8 -*-
+#
+# python-mpd2 documentation build configuration file, created by
+# sphinx-quickstart on Thu Apr 4 09:22:21 2013.
+#
+# 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.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# 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.viewcode']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'python-mpd2'
+copyright = u'2013, Jörg Thalheim'
+
+# 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.5.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.5.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 patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_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 = []
+
+# If true, keep warnings as "system message" paragraphs in the built documents.
+#keep_warnings = False
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+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_domain_indices = 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, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'python-mpd2doc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'python-mpd2.tex', u'python-mpd2 Documentation',
+ u'Jörg Thalheim', '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
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'python-mpd2', u'python-mpd2 Documentation',
+ [u'Jörg Thalheim'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+# dir menu entry, description, category)
+texinfo_documents = [
+ ('index', 'python-mpd2', u'python-mpd2 Documentation',
+ u'Jörg Thalheim', 'python-mpd2', 'One line description of project.',
+ 'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+# If true, do not generate a @detailmenu in the "Top" node's menu.
+#texinfo_no_detailmenu = False
diff --git a/doc/index.rst b/doc/index.rst
new file mode 100644
index 0000000..73e2815
--- /dev/null
+++ b/doc/index.rst
@@ -0,0 +1,50 @@
+python-mpd2 Documentation
+=========================
+
+*python-mpd2* is a Python library which provides a client interface for
+the `Music Player Daemon <http://musicpd.org>`__.
+
+Difference with python-mpd
+--------------------------
+
+python-mpd2 is a fork of `python-mpd`_. While 0.4.x was backwards compatible
+with python-mpd, starting with 0.5 provides enhanced features which are *NOT*
+backward compatibles with the original `python-mpd`_ package. See
+:doc:`Porting <topics/porting>` for more information.
+
+The following features were added:
+
+- Python 3 support (but you neead at least Python 2.6)
+- support for the upcoming client-to-client protocol
+- support for new commands from MPD v0.17 (seekcur, prio, prioid,
+ config, searchadd, searchaddpl)
+- remove deprecated commands (volume)
+- explicitly declared MPD commands (which is handy when using for
+ example `IPython <http://ipython.org>`__)
+- a test suite
+- API documentation to add new commands (see :doc:`Future Compatible <topics/advanced>`)
+- support for Unicode strings in all commands (optionally in python2,
+ default in python3 - see :doc:`Unicode Handling <topics/advanced>`)
+- configureable timeouts
+- support for :doc:`logging <topics/logging>`
+- improved support for sticker
+- improved support for ranges
+
+If you like this module, you could try contact the original author
+jat at spatialrift.net or join the discussion on the
+`issue tracker <http://jatreuman.indefero.net/p/python-mpd/issues/7/>`__ so that
+it gets merged upstream.
+
+Getting Started
+===============
+
+A quick guide for getting started python-mpd2:
+
+* :doc:`Getting Started <topics/getting-started>`
+
+.. _python-mpd: http://jatreuman.indefero.net/p/python-mpd/
+
+Changelog
+=========
+
+* :doc:`Change log <changes>`
diff --git a/doc/topics/advanced.rst b/doc/topics/advanced.rst
new file mode 100644
index 0000000..a02c831
--- /dev/null
+++ b/doc/topics/advanced.rst
@@ -0,0 +1,67 @@
+Future Compatible
+-----------------
+
+New commands or special handling of commands can be easily implemented. Use
+``add_command()`` or ``remove_command()`` to modify the commands of the
+*MPDClient* class and all its instances.::
+
+ def fetch_cover(client):
+ """"Take a MPDClient instance as its arguments and return mimetype and image"""
+ # this command may come in the future.
+ pass
+
+ self.client.add_command("get_cover", fetch_cover)
+ # you can then use:
+ self.client.fetch_cover()
+
+ # remove the command, because it doesn't exist already.
+ self.client.remove_command("get_cover")
+
+
+Thread-Safety
+-------------
+
+Currently ``MPDClient`` is **NOT** thread-safe. As it use a socket internaly,
+only one thread can send or receive at the time.
+
+But ``MPDClient`` can be easily extended to be thread-safe using `locks
+<http://docs.python.org/library/threading.html#lock-objects>`__. Take a look at
+``examples/locking.py`` for further informations.
+
+
+Unicode Handling
+----------------
+
+To quote the mpd protocol documentation:
+
+> All data to be sent between the client and server must be encoded in UTF-8.
+
+With Python 3:
+~~~~~~~~~~~~~~
+
+In Python 3, Unicode string is the default string type. So just pass these
+strings as arguments for MPD commands and *python-mpd2* will also return such
+Unicode string.
+
+With Python 2.x
+~~~~~~~~~~~~~~~
+
+For backward compatibility with *python-mpd*, when running with Python 2.x,
+*python-mpd2* accepts both Unicode strings (ex. u"♥") and UTF-8 encoded strings
+(ex. "♥").
+
+In order for *MPDClient* to return Unicode strings with Python 2, create the
+instance with the ``use_unicode`` parameter set to ``True``.
+
+Using Unicode strings should be prefered as it is done transparently by the
+library for you, and makes the transition to Python 3 easier::
+
+ >>> import mpd
+ >>> client = MPDClient(use_unicode=True)
+ >>> client.urlhandlers()[0]
+ u'http'
+ >>> client.use_unicode = False # Can be switched back later
+ >>> client.urlhandlers()[0]
+ 'http'
+
+Using this option in Python 3 doesn't have any effect.
diff --git a/doc/topics/getting-started.rst b/doc/topics/getting-started.rst
new file mode 100644
index 0000000..95e0dee
--- /dev/null
+++ b/doc/topics/getting-started.rst
@@ -0,0 +1,69 @@
+Using the client library
+------------------------
+
+The client library can be used as follows::
+
+ >>> client = mpd.MPDClient() # create client object
+ >>> client.timeout = 10 # network timeout in seconds (floats allowed), default: None
+ >>> client.idletimeout = None # timeout for fetching the result of the idle command is handled seperately, default: None
+ >>> client.connect("localhost", 6600) # connect to localhost:6600
+ >>> print(client.mpd_version) # print the MPD version
+ >>> print(client.find("any", "house")) # print result of the command "find any house"
+ >>> client.close() # send the close command
+ >>> client.disconnect() # disconnect from the server
+
+A list of supported commands, their arguments (as MPD currently understands
+them), and the functions used to parse their responses can be found in
+:doc:`Commands <commands>`. See the `MPD protocol documentation
+<http://www.musicpd.org/doc/protocol/>`__ for more details.
+
+Command lists are also supported using *command\_list\_ok\_begin()* and
+*command\_list\_end()*::
+
+ >>> client.command_list_ok_begin() # start a command list
+ >>> client.update() # insert the update command into the list
+ >>> client.status() # insert the status command into the list
+ >>> results = client.command_list_end() # results will be a list with the results
+
+Commands may also return iterators instead of lists if *iterate* is set
+to *True*::
+
+ client.iterate = True
+ for song in client.playlistinfo():
+ print song["file"]
+
+Each command have a *send\_* and a *fetch\_* variant, which allows to send a MPD
+command and then fetch the result later. This is useful for the idle command::
+
+ >>> client.send_idle()
+ # do something else or use function like select(): http://docs.python.org/howto/sockets.html#non-blocking-sockets
+ # ex. select([client], [], []) or with gobject: http://jatreuman.indefero.net/p/python-mpd/page/ExampleIdle/
+ >>> events = client.fetch_idle()
+
+Some more complex usage examples can be found
+`here <http://jatreuman.indefero.net/p/python-mpd/doc/>`_
+
+Range
+-----
+
+Some commands support integer ranges as argument. This is done in python-mpd2
+by using two element tuple::
+
+ # move the first three songs
+ # after the last in the playlist
+ >>> client.status()
+ ['file: song1.mp3',
+ 'file: song2.mp3',
+ 'file: song3.mp3',
+ 'file: song4.mp3']
+ >>> client.move((0,3), 1)
+ >>> client.status()
+ ['file: song4.mp3'
+ 'file: song1.mp3',
+ 'file: song2.mp3',
+ 'file: song3.mp3',]
+
+Second element can be omitted. MPD will assumes the biggest possible number then (don't forget the comma!)::
+NOTE: mpd versions between 0.16.8 and 0.17.3 contains a bug, so ommiting doesn't work.
+
+ >>> client.delete((1,)) # delete all songs, but the first.
diff --git a/doc/topics/logging.rst b/doc/topics/logging.rst
new file mode 100644
index 0000000..412e202
--- /dev/null
+++ b/doc/topics/logging.rst
@@ -0,0 +1,15 @@
+Logging
+-------
+
+By default messages are sent to the logger named ``mpd``::
+
+ >>> import logging, mpd
+ >>> logging.basicConfig(level=logging.DEBUG)
+ >>> client = mpd.MPDClient()
+ >>> client.connect("localhost", 6600)
+ INFO:mpd:Calling MPD connect('localhost', 6600, timeout=None)
+ >>> client.find('any', 'dubstep')
+ DEBUG:mpd:Calling MPD find('any', 'dubstep')
+
+For more information about logging configuration, see
+http://docs.python.org/2/howto/logging.html
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-mpd/python-mpd.git
More information about the Pkg-mpd-commits
mailing list