Library to extract song lyrics from www.animelyrics.com
Project description
animelyrics
Python API to retrieve song lyrics from animelyrics.
Features
- Search for lyrics from animelyrics website
- Japanese (romaji) and english translated text support
- Show title on top of lyrics
Prerequisties
- Python >=3.0.0
Install
pip install animelyrics
Simple! 🎉
Usage
import animelyrics
print(animelyrics.search_lyrics("renai circulation"))
Multi-language search
The language of the lyrics can be specified using the lang
argument during the function call:
import animelyrics
print(animelyrics.search_lyrics("god knows", lang="en"))
Currently the API only supports the following inputs
jp
- romaji texten
- translated english text
Song Titles
To add the song title and the anime where it came from to the lyrics, use the show_title
argument
import animelyrics
print(animelyrics.search_lyrics("snow halation", show_title=True))
Exceptions
The API contains the following exception that will be raised in different scenarios
InvalidLanguage
MissingTranslatedLyrics
NoLyricsFound
The following example shows how to cover all exceptions while searching for lyrics:
import animelyrics
try:
lyrics = animelyrics.search_lyrics("song lyrics")
except animelyrics.MissingTranslatedLyrics:
# case when english language is used but no translation is found
except animelyrics.NoLyricsFound:
# case when no lyrics are found
Test
python setup.py test
Author
🕺 Melvin Yeo
- GitHub: @colorfusion
🤝 Contributing
Contributions, issues, and feature requests are welcome!"
Check out the issues page
Support
Please ⭐ this repository if it is helpful to you!
License
Copyright © 2019 Melvin Yeo.
This project is MIT licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file animelyrics-0.1.0-py2.py3-none-any.whl
.
File metadata
- Download URL: animelyrics-0.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 5.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d2d0c2c8ecf6d5b83a49d0faaeb6f39c8f177cdc836248c82da1322725044bd |
|
MD5 | b18c27da5f1c63f195ccb756ba0109ff |
|
BLAKE2b-256 | 742941eca754bd3f74abb22349faf4e82225754065e64d34bd821aa6bd752e3a |