beetbox/beets

lyrics: Configuration option for ReST writing

Open

#2,806 opened on Jan 31, 2018

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (12,133 stars) (1,837 forks)batch import
featuregood first issuelyrics

Description

The title says it all. I think it could be great to have a lyrics.default_directory entry in the configuration file for a default directory in which the lyrics file will be written, instead of always specifying it manually with -r or --write-rest. Usually I run this command not from a specific directory so this could be useful.

Contributor guide

Tech stack
python
Domain
cli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Python programmingbeets plugin structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate the lyrics plugin implementation in beetsplug/lyrics.py. Look for existing configuration options to understand the pattern. Implement a new config key 'default directory' and use it in the write functions. Update documentation accordingly.