:py:mod:`calliope.beets`
========================

.. py:module:: calliope.beets

.. autoapi-nested-parse::

   Query the `Beets music organiser <https://beets.io>`_.

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



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


Functions
~~~~~~~~~

.. autoapisummary::

   calliope.beets.albums
   calliope.beets.artists
   calliope.beets.tracks



.. py:function:: albums(query, include_tracks = False)

   Export album data from Beets as a playlist.

   :param query: A `Beets query string <https://beets.readthedocs.io/en/stable/reference/query.html>`_                (use ``.`` to return everything).
   :param include_tracks: Expand the tracklist of each album.

   :returns: A playlist containing albums or album tracks.


.. py:function:: artists(query)

   Export artist data from Beets as a playlist.

   :param query: A `Beets query string <https://beets.readthedocs.io/en/stable/reference/query.html>`_             (use ``.`` to return everything).

   :returns: A playlist of items with ``creator`` set..


.. py:function:: tracks(query)

   Export songs from Beets as a playlist.

   :param query: A `Beets query string <https://beets.readthedocs.io/en/stable/reference/query.html>`_             (use ``.`` to return everything).

   :returns: A playlist.