beetbox/beets

lyrics: Configuration option for ReST writing

Closed

#2,806 opened on Jan 31, 2018

View on GitHubContributor guide
 (8 comments) (0 reactions) (0 assignees)Python (1,837 forks)batch import
featuregood first issuelyrics

Repository metrics

Stars
 (12,133 stars)
PR merge metrics
 (Avg merge 26d 4h) (51 merged PRs in 30d)

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

Research direction
Locate the lyrics plugin in beets source, find how configuration options are defined (using beets' config system), add a 'default directory' option to the plugin's config, and modify the write REST method to use that directory when r is not specified.
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70