File: importfeeds.rst

package info (click to toggle)
beets 2.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 8,536 kB
  • sloc: python: 45,608; javascript: 7,997; xml: 334; sh: 261; makefile: 119
file content (50 lines) | stat: -rw-r--r-- 1,889 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
ImportFeeds Plugin
==================

This plugin helps you keep track of newly imported music in your library.

To use the ``importfeeds`` plugin, enable it in your configuration
(see :ref:`using-plugins`).

Configuration
-------------

To configure the plugin, make an ``importfeeds:`` section in your
configuration file. The available options are:

- **absolute_path**: Use absolute paths instead of relative paths. Some
  applications may need this to work properly.
  Default: ``no``.
- **dir**: The output directory.
  Default: Your beets library directory.
- **formats**: Select the kind of output. Use one or more of:

   - **m3u**: Catalog the imports in a centralized playlist.
   - **m3u_multi**: Create a new playlist for each import (uniquely named by
     appending the date and track/album name).
   - **m3u_session**: Create a new playlist for each import session. The file
     is named as ``m3u_name`` appending the date and time the import session
     was started.
   - **link**: Create a symlink for each imported item. This is the
     recommended setting to propagate beets imports to your iTunes library:
     just drag and drop the ``dir`` folder on the iTunes dock icon.
   - **echo**: Do not write a playlist file at all, but echo a list of new
     file paths to the terminal.

  Default: None.
- **m3u_name**: Playlist name used by the ``m3u`` format and as a prefix used
  by the ``m3u_session`` format.
  Default: ``imported.m3u``.
- **relative_to**: Make the m3u paths relative to another
  folder than where the playlist is being written. If you're using importfeeds
  to generate a playlist for MPD, you should set this to the root of your music
  library.
  Default: None.

Here's an example configuration for this plugin::

    importfeeds:
        formats: m3u link
        dir: ~/imports/
        relative_to: ~/Music/
        m3u_name: newfiles.m3u