MatthiasQuintern/nicole
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed README

Browse Source
This commit is contained in:
matthias@arch 2021-09-29 04:24:35 +02:00
parent 872cf98549
commit dd95f335bc
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,16 +1,16 @@
# Nicole - Lyrics Scraper # Nicole - Lyrics Scraper
##Overview: ## Overview
Nicole is a program that searches for lyrics and writes them into the mp3-tag "USLT". Nicole is a program that searches for lyrics and writes them into the mp3-tag "USLT".
There is a 5 second delay between each request to azlyrics.com because the site will block your ip if there are too many requests. There is a 5 second delay between each request to azlyrics.com because the site will block your ip if there are too many requests.
###History: ### History
Nicole can create a history of all files that were processed in `~/.configs/nicole`. Nicole can create a history of all files that were processed in `~/.configs/nicole`.
If a file is in the history, it will be skipped unless `ignore_history=True`. If a file is in the history, it will be skipped unless `ignore_history=True`.
If the lyrics for a file can not be obtained, it is added to `~/.configs/nicole/failed_files`. If the lyrics for a file can not be obtained, it is added to `~/.configs/nicole/failed_files`.
Those files are not skipped, the file only exists so that you can see which lyrics were not downloaded. Those files are not skipped, the file only exists so that you can see which lyrics were not downloaded.
###azlyrics: ### azlyrics
Nicole creates a azlyrics.com url from the title and artist mp3-tags of the file. Nicole creates a azlyrics.com url from the title and artist mp3-tags of the file.
The lyrics are extracted from the html document using regex. The lyrics are extracted from the html document using regex.
@ -38,5 +38,5 @@ python3 -m pip install .
``` ```
You can also install it system-wide using `sudo python3 -m pip install.` You can also install it system-wide using `sudo python3 -m pip install.`
## Importand Notice: ## Importand Notice
This software comes with no warranty! This software comes with no warranty!