wzray/lrc-dl
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename module from lyrics-dl to lrc-dl

Browse source
This commit is contained in:
mrsobakin 2024-11-11 05:25:48 +03:00
parent 4bfcbf17bd
commit 658e1bef77
No known key found for this signature in database
GPG key ID: 325CBF665E4FFD6E
16 changed files with 52 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,4 +1,4 @@
# :musical_note: lyrics-dl
# :musical_note: lrc-dl
An ultimate CLI tool for downloading lyrics for songs, inspired by other awesome *-dl projects.
@ -9,11 +9,11 @@ Before you begin, make sure you have `python3` and `pip` installed.
0. If you wish to use the `youtube` provider, install `ffmpeg` and add it to your `PATH`.
1. Clone the repository:
```bash
git clone https://github.com/mrsobakin/lyrics-dl.git
git clone https://github.com/mrsobakin/lrc-dl.git
```
2. Navigate to the project directory:
```bash
cd lyrics-dl
cd lrc-dl
```
3. Install the package:
```bash
@ -22,12 +22,12 @@ Before you begin, make sure you have `python3` and `pip` installed.
## Usage
You can use `lyrics-dl` both as a CLI tool and as a Python module.
You can use `lrc-dl` both as a CLI tool and as a Python module.
### CLI Usage
```bash
lyrics-dl [-h] [-c CONFIG] [-e EXTENSIONS] [-f] path
lrc-dl [-h] [-c CONFIG] [-e EXTENSIONS] [-f] path
```
#### Positional Arguments:
@ -37,18 +37,18 @@ lyrics-dl [-h] [-c CONFIG] [-e EXTENSIONS] [-f] path
#### Options:
- `-h, --help`: Display help message and exit.
- `-c CONFIG, --config CONFIG`: Specify a custom config file (in TOML format) for `lyrics-dl`.
- `-c CONFIG, --config CONFIG`: Specify a custom config file (in TOML format) for `lrc-dl`.
- `-e EXTENSIONS, --extensions EXTENSIONS`: Define music file extensions, separated by commas (e.g., wav,flac,mp3).
- `-f, --force-override`: Force override .lrc file, if it already exists.
### Usage as a Python Module
You can also use `lyrics-dl` as a Python module, allowing you to integrate its functionality directly into your own scripts or applications.
You can also use `lrc-dl` as a Python module, allowing you to integrate its functionality directly into your own scripts or applications.
#### Initializing `LyricsDl`
```python
from lyrics_dl import LyricsDl, LyricsDlConfig
from lrc_dl import LyricsDl, LyricsDlConfig
# Create a LyricsDl instance with default configuration
ldl = LyricsDl()
@ -61,7 +61,7 @@ ldl = LyricsDl(config=config)
#### Fetching Lyrics for a Song
```python
from lyrics_dl import Song
from lrc_dl import Song
# Create a Song object
song = Song(title="Where'd All The Time Go?", artist="Dr. Dog")
@ -106,7 +106,7 @@ For more detailed information on the usage of the `LyricsDl` class, `Song` class
## Configuration
By default, lyrics-dl searches for the configuration file at `$XDG_CONFIG_HOME/lyrics-dl/config.toml`. You can specify custom config location using `-c` flag.
By default, lrc-dl searches for the configuration file at `$XDG_CONFIG_HOME/lrc-dl/config.toml`. You can specify custom config location using `-c` flag.
The configuration is using the TOML format.
Global provider parameters (for example, services order) are defined under the `[providers]` section.
@ -118,7 +118,7 @@ As an example, to enable the `musixmatch` provider, you'll need to [acquire a Mu
[providers]
order = ["musixmatch", "kugou"]
delay = 10 # Seconds to wait between searches
prepend_header = true # Prepend lyrics-dl's & provider's header to keep track of lyrics source
prepend_header = true # Prepend lrc-dl's & provider's header to keep track of lyrics source
[providers.musixmatch]
token = "YOUR_TOKEN"