:py:mod:`calliope`
==================

.. py:module:: calliope

.. autoapi-nested-parse::

   Calliope is a set of tools for processing playlists.

   This module contains the core parts of Calliope.



Subpackages
-----------
.. toctree::
   :titlesonly:
   :maxdepth: 3

   bandcamp/index.rst
   beets/index.rst
   diff/index.rst
   export/index.rst
   import_/index.rst
   lastfm/index.rst
   listenbrainz/index.rst
   musicbrainz/index.rst
   play/index.rst
   select/index.rst
   shuffle/index.rst
   spotify/index.rst
   stat/index.rst
   subprojects/index.rst
   suggest/index.rst
   sync/index.rst
   tracker/index.rst
   validate/index.rst
   youtube/index.rst


Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   __main__/index.rst
   cache/index.rst
   cli/index.rst
   config/index.rst
   database/index.rst
   interface/index.rst
   playlist/index.rst
   resolvers/index.rst
   sync_operation/index.rst
   utils/index.rst


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

Classes
~~~~~~~

.. autoapisummary::

   calliope.ContentResolver
   calliope.ListenHistoryProvider



Functions
~~~~~~~~~

.. autoapisummary::

   calliope.uri_to_path
   calliope.available_content_resolvers
   calliope.available_listen_history_providers



Attributes
~~~~~~~~~~

.. autoapisummary::

   calliope.__VERSION__


.. py:class:: ContentResolver


   Interface for modules that can resolve playable tracks.

   .. py:method:: authenticate()
      :abstractmethod:


   .. py:method:: resolve_content(playlist)
      :abstractmethod:



.. py:class:: ListenHistoryProvider


   Interface for modules that provide a person's listening history.

   .. py:method:: prepare_sync()
      :abstractmethod:


   .. py:method:: annotate(item)
      :abstractmethod:


   .. py:method:: scrobbles()
      :abstractmethod:


   .. py:method:: listens()
      :abstractmethod:


   .. py:method:: artists(first_play_before=None, first_play_since=None, last_play_before=None, last_play_since=None, min_listens=1, show_listens_since=None)
      :abstractmethod:


   .. py:method:: tracks(first_play_before=None, first_play_since=None, last_play_before=None, last_play_since=None, min_listens=1, show_listens_since=None)
      :abstractmethod:


   .. py:method:: histogram(bucket='year')
      :abstractmethod:



.. py:data:: __VERSION__
   :value: 'uninstalled'

   

.. py:function:: uri_to_path(uri)

   Convert a file:/// URI to a pathlib.Path.


.. py:function:: available_content_resolvers()

   List of available classes supporting a `resolve_content` method.

   The list is:

     * :class:`calliope.spotify.SpotifyContext`
     * :class:`calliope.tracker.TrackerClient`



.. py:function:: available_listen_history_providers()

   List of available classes supporting the listen history interface.

   (This interface is not yet defined explicitly).

   The list is:

     * :class:`calliope.lastfm.history.ListenHistory`
     * :class:`calliope.listenbrainz.listens.History`