:py:mod:`calliope.tracker`
==========================

.. py:module:: calliope.tracker

.. autoapi-nested-parse::

   Export data from the `Tracker desktop search engine <gnome.pages.gitlab.gnome.org/tracker/>`_.

   See also: :program:`cpe tracker` command.



Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   calliope.tracker.TrackerClient



Functions
~~~~~~~~~

.. autoapisummary::

   calliope.tracker.annotate_images
   calliope.tracker.resolve_content
   calliope.tracker.resolve_image
   calliope.tracker.expand_tracks



Attributes
~~~~~~~~~~

.. autoapisummary::

   calliope.tracker.TRACKER_INDEXER


.. py:data:: TRACKER_INDEXER
   :annotation: = org.freedesktop.Tracker3.Miner.Files

   

.. py:class:: TrackerClient(http_endpoint=None)

   Helper functions for querying from the user's Tracker database.

   .. py:method:: query(query)

      Run a single SPARQL query.


   .. py:method:: artist_id(artist_name)

      Return the Tracker URN for a given artist.


   .. py:method:: artist_name(artist_id)

      Return the name of a given artist.


   .. py:method:: artists_by_number_of_songs(limit = None)

      Return a list of artists by number of songs known.


   .. py:method:: albums(filter_artist_name = None, filter_album_name = None)

      Return a list of releases.


   .. py:method:: track(artist_name, track_name)

      Find a specific track by name.

      Tries to find a track matching the given artist and title.

      Returns a playlist entry, or None.



   .. py:method:: tracks(filter_artist_name = None, filter_album_name = None)

      Return a list of tracks.


   .. py:method:: tracks_grouped_by_album(filter_artist_name = None, filter_album_name = None, filter_track_name = None)

      Return all songs matching specific search criteria.

      These are grouped into their respective releases. Any tracks that
      aren't present on any releases will appear last. Any tracks that
      appear on multiple releases will appear multiple times.



   .. py:method:: artists()

      Return all artists who have at least one track available locally.


   .. py:method:: search(search_text)

      Return a list of tracks which match 'search_text'.

      The text may be matched in the artist name, track title or album name.



.. py:function:: annotate_images(tracker, playlist)

   Resolve images from local media-art cache.


.. py:function:: resolve_content(tracker, playlist)

   Resolve content locations from the local filesystem.


.. py:function:: resolve_image(tracker, playlist)

   Resolve ``image`` from local media-art cache.


.. py:function:: expand_tracks(tracker, playlist)

   Expand an ``album`` item into a list of the album's tracks.