Skip to main content

animelyrics

Build Status Coverage Status Code style: black made-with-python MIT license

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"))

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 text
  • en - 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

🤝 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.

Metadata

Release files for animelyrics 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for animelyrics 0.1.0
File Interpreter ABI Platform Actions
animelyrics-0.1.0-py2.py3-none-any.whl Python 2, Python 3 none any Details for animelyrics-0.1.0-py2.py3-none-any.whl

Release files / animelyrics-0.1.0-py2.py3-none-any.whl

Download URL animelyrics-0.1.0-py2.py3-none-any.whl
Size 5.6 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
7d2d0c2c8ecf6d5b83a49d0faaeb6f39c8f177cdc836248c82da1322725044bd
BLAKE2b-256 checksum
How to use checksums
742941eca754bd3f74abb22349faf4e82225754065e64d34bd821aa6bd752e3a
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for animelyrics 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

1 release file No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page