From: Kaliko Jack <kaliko@azylum.org>
Date: Thu, 31 Jan 2019 14:56:42 +0000 (+0100)
Subject: Add a "Library overview" section in doc
X-Git-Tag: v0.4.4~7
X-Git-Url: https://git.kaliko.me/?p=python-musicpd.git;a=commitdiff_plain;h=1273e7e588476940dd5e9d862be7f18de0db708b

Add a "Library overview" section in doc
---

diff --git a/doc/source/index.rst b/doc/source/index.rst
index c55d08d..fdfeb70 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -16,6 +16,31 @@ Installation
     pip install git+https://gitlab.com/kaliko/python-musicpd.git
 
 
+Library overview
+----------------
+Here is a snippet allowing to list the last modified artists in the media library:
+
+.. code:: python3
+
+        #!/usr/bin/env python3
+        # coding: utf-8
+        import musicpd
+
+        def main():
+            cli = musicpd.MPDClient()
+            cli.connect()
+            # Gets files count in the library
+            nb_files = int(cli.stats()['songs'])
+            # Gets the last 100 files modified
+            files = cli.search('file', '', 'sort', 'Last-Modified', 'window', (nb_files-100,))
+            # Print last modified artists in media library
+            print(' / '.join({f.get('albumartist') for f in files}))
+            cli.disconnect()
+
+        # Script starts here
+        if __name__ == '__main__':
+            main()
+
 
 Build documentation
 --------------------