# pyjlyric: Japanese Lyric Aggregator
[![PyPI](
<https://img.shields.io/pypi/v/pyjlyric?color=blue>
) ![Python Version](
<https://img.shields.io/pypi/pyversions/pyjlyric>
)](
<https://pypi.org/project/pyjlyric/>
) [![Release Package](
<https://github.com/eggplants/pyjlyric/actions/workflows/release.yml/badge.svg>
)](
<https://github.com/eggplants/pyjlyric/actions/workflows/release.yml>
) [![Ghcr](
<https://ghcr-badge.egpl.dev/eggplants/pyjlyric/size>
)](
<https://github.com/eggplants/pyjlyric/pkgs/container/pyjlyric/74193340?tag=latest>
)
[![pre-commit.ci status](
<https://results.pre-commit.ci/badge/github/eggplants/pyjlyric/master.svg>
)](
<https://results.pre-commit.ci/latest/github/eggplants/pyjlyric/master>
) [![Maintainability](
<https://api.codeclimate.com/v1/badges/efdc16e97af8b8914ce9/maintainability>
)](
<https://codeclimate.com/github/eggplants/pyjlyric/maintainability>
) [![Test Coverage](
<https://api.codeclimate.com/v1/badges/efdc16e97af8b8914ce9/test_coverage>
)](
<https://codeclimate.com/github/eggplants/pyjlyric/test_coverage>
)
## Supported sites
- <http://www.animap.jp/kasi/showkasi.php?surl=:pageid>
- <http://www.utamap.com/showtop.php?surl=:pageid>
- <https://gakufu.gakki.me/m/data/:pageid.html>
- <https://hoick.jp/mdb/detail/:pageid>
- <https://j-lyric.net/artist/:artistid/:pageid.html>
- <https://kashinavi.com/song_view.html?:pageid>
- <https://linkco.re/:albumid/songs/:songid/lyrics>
- <https://lyric.evesta.jp/:pageid.html>
- <https://music-book.jp/music/Artist/:artistid/Music/:pageid>
- <https://music.j-total.net/data/:pageid.html>
- <https://petitlyrics.com/lyrics/:pageid>
- <https://utaten.com/lyric/:pageid>
- <https://www.joysound.com/web/search/song/:pageid>
- <https://www.uta-net.com/song/:pageid>
## Installation
```sh
pip install git+https://github.com/eggplants/pyjlyric
# or
pip install pyjlyric
```
## Usage
### CLI
<!-- markdownlint-disable MD010 -->
```shellsession
$ jrc https://j-lyric.net/artist/a00126c/l013283.html
===
Title: 春よ来い
Artist: 童謡・唱歌
Lyric: 相馬 御風
Composer: 弘田 龍太郎
===
春よ来い早く来い
あるきはじめたみいちゃんが
赤い鼻緒のじょじょはいて
おんもへ出たいと待っている
春よ来い早く来い
おうちの前の桃の木の
蕾もみんなふくらんで
はよ咲きたいと待っている
```
<!-- markdownlint-enable MD010 -->
```shellsession
$ jrc -h
usage: jrc [-h] [-V] url
get lyric data by URL.
positional arguments:
url
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
supported sites:
- http://www.animap.jp/kasi/showkasi.php?surl=:pageid
- http://www.utamap.com/showtop.php?surl=:pageid
- https://gakufu.gakki.me/m/data/:pageid.html
- https://hoick.jp/mdb/detail/:pageid
- https://j-lyric.net/artist/:artistid/:pageid.html
- https://kashinavi.com/song_view.html?:pageid
- https://linkco.re/:albumid/songs/:songid/lyrics
- https://lyric.evesta.jp/:pageid.html
- https://music-book.jp/music/Artist/:artistid/Music/:pageid
- https://music.j-total.net/data/:pageid.html
- https://petitlyrics.com/lyrics/:pageid
- https://utaten.com/lyric/:pageid
- https://www.joysound.com/web/search/song/:pageid
- https://www.uta-net.com/song/:pageid
```
### Library
```python
import pyjlyric
pyjlyric.parse("https://kashinavi.com/song_view.html?155779")
```
Returns:
```python
KashinaviLyricPage(
title='Life goes on',
page_url=HttpUrl('https://kashinavi.com/song_view.html?155779', ),
pageid='155779',
artist=WithUrlText(
link=HttpUrl('https://kashinavi.com/artist.html?artist=104498&kashu=King+%26+Prince&start=1', ),
text='King & Prince'
),
composer='Joacim Persson・Johan Alkenas・SQVARE・Sean Michael Alexander',
lyricist='木村友威',
arranger=None,
lyric_sections=[['Keep it up, keep it up yup'], [...], [..., "Let's live it up"]]
)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/eggplants/pyjlyric",
"name": "pyjlyric",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "japanese, lyrics, download-lyrics, lyrics-scraping, japanese-songs",
"author": "eggplants",
"author_email": "w10776e8w@yahoo.co.jp",
"download_url": "https://files.pythonhosted.org/packages/76/81/0a7a06c92e0c25ec405bf0e9edb11d203a334aec3d0fb74e7739c689374a/pyjlyric-1.3.1.tar.gz",
"platform": null,
"description": "# pyjlyric: Japanese Lyric Aggregator\n\n[![PyPI](\n <https://img.shields.io/pypi/v/pyjlyric?color=blue>\n ) ![Python Version](\n <https://img.shields.io/pypi/pyversions/pyjlyric>\n )](\n <https://pypi.org/project/pyjlyric/>\n) [![Release Package](\n <https://github.com/eggplants/pyjlyric/actions/workflows/release.yml/badge.svg>\n )](\n <https://github.com/eggplants/pyjlyric/actions/workflows/release.yml>\n) [![Ghcr](\n <https://ghcr-badge.egpl.dev/eggplants/pyjlyric/size>\n )](\n <https://github.com/eggplants/pyjlyric/pkgs/container/pyjlyric/74193340?tag=latest>\n)\n\n[![pre-commit.ci status](\n <https://results.pre-commit.ci/badge/github/eggplants/pyjlyric/master.svg>\n )](\n <https://results.pre-commit.ci/latest/github/eggplants/pyjlyric/master>\n) [![Maintainability](\n <https://api.codeclimate.com/v1/badges/efdc16e97af8b8914ce9/maintainability>\n )](\n <https://codeclimate.com/github/eggplants/pyjlyric/maintainability>\n) [![Test Coverage](\n <https://api.codeclimate.com/v1/badges/efdc16e97af8b8914ce9/test_coverage>\n )](\n <https://codeclimate.com/github/eggplants/pyjlyric/test_coverage>\n)\n\n## Supported sites\n\n- <http://www.animap.jp/kasi/showkasi.php?surl=:pageid>\n- <http://www.utamap.com/showtop.php?surl=:pageid>\n- <https://gakufu.gakki.me/m/data/:pageid.html>\n- <https://hoick.jp/mdb/detail/:pageid>\n- <https://j-lyric.net/artist/:artistid/:pageid.html>\n- <https://kashinavi.com/song_view.html?:pageid>\n- <https://linkco.re/:albumid/songs/:songid/lyrics>\n- <https://lyric.evesta.jp/:pageid.html>\n- <https://music-book.jp/music/Artist/:artistid/Music/:pageid>\n- <https://music.j-total.net/data/:pageid.html>\n- <https://petitlyrics.com/lyrics/:pageid>\n- <https://utaten.com/lyric/:pageid>\n- <https://www.joysound.com/web/search/song/:pageid>\n- <https://www.uta-net.com/song/:pageid>\n\n## Installation\n\n```sh\npip install git+https://github.com/eggplants/pyjlyric\n# or\npip install pyjlyric\n```\n\n## Usage\n\n### CLI\n\n<!-- markdownlint-disable MD010 -->\n\n```shellsession\n$ jrc https://j-lyric.net/artist/a00126c/l013283.html\n===\nTitle:\t\t\u6625\u3088\u6765\u3044\nArtist:\t\t\u7ae5\u8b21\u30fb\u5531\u6b4c\nLyric:\t\t\u76f8\u99ac \u5fa1\u98a8\nComposer:\t\u5f18\u7530 \u9f8d\u592a\u90ce\n===\n\u6625\u3088\u6765\u3044\u65e9\u304f\u6765\u3044\n\u3042\u308b\u304d\u306f\u3058\u3081\u305f\u307f\u3044\u3061\u3083\u3093\u304c\n\u8d64\u3044\u9f3b\u7dd2\u306e\u3058\u3087\u3058\u3087\u306f\u3044\u3066\n\u304a\u3093\u3082\u3078\u51fa\u305f\u3044\u3068\u5f85\u3063\u3066\u3044\u308b\n\n\u6625\u3088\u6765\u3044\u65e9\u304f\u6765\u3044\n\u304a\u3046\u3061\u306e\u524d\u306e\u6843\u306e\u6728\u306e\n\u857e\u3082\u307f\u3093\u306a\u3075\u304f\u3089\u3093\u3067\n\u306f\u3088\u54b2\u304d\u305f\u3044\u3068\u5f85\u3063\u3066\u3044\u308b\n```\n\n<!-- markdownlint-enable MD010 -->\n\n```shellsession\n$ jrc -h\nusage: jrc [-h] [-V] url\n\nget lyric data by URL.\n\npositional arguments:\n url\n\noptions:\n -h, --help show this help message and exit\n -V, --version show program's version number and exit\n\nsupported sites:\n - http://www.animap.jp/kasi/showkasi.php?surl=:pageid\n - http://www.utamap.com/showtop.php?surl=:pageid\n - https://gakufu.gakki.me/m/data/:pageid.html\n - https://hoick.jp/mdb/detail/:pageid\n - https://j-lyric.net/artist/:artistid/:pageid.html\n - https://kashinavi.com/song_view.html?:pageid\n - https://linkco.re/:albumid/songs/:songid/lyrics\n - https://lyric.evesta.jp/:pageid.html\n - https://music-book.jp/music/Artist/:artistid/Music/:pageid\n - https://music.j-total.net/data/:pageid.html\n - https://petitlyrics.com/lyrics/:pageid\n - https://utaten.com/lyric/:pageid\n - https://www.joysound.com/web/search/song/:pageid\n - https://www.uta-net.com/song/:pageid\n```\n\n### Library\n\n```python\nimport pyjlyric\n\npyjlyric.parse(\"https://kashinavi.com/song_view.html?155779\")\n```\n\nReturns:\n\n```python\nKashinaviLyricPage(\n title='Life goes on',\n page_url=HttpUrl('https://kashinavi.com/song_view.html?155779', ),\n pageid='155779',\n artist=WithUrlText(\n link=HttpUrl('https://kashinavi.com/artist.html?artist=104498&kashu=King+%26+Prince&start=1', ),\n text='King & Prince'\n ),\n composer='Joacim Persson\u30fbJohan Alkenas\u30fbSQVARE\u30fbSean Michael Alexander',\n lyricist='\u6728\u6751\u53cb\u5a01',\n arranger=None,\n lyric_sections=[['Keep it up, keep it up yup'], [...], [..., \"Let's live it up\"]]\n)\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Japanese Lyric Aggregator",
"version": "1.3.1",
"project_urls": {
"Homepage": "https://github.com/eggplants/pyjlyric",
"Repository": "https://github.com/eggplants/pyjlyric"
},
"split_keywords": [
"japanese",
" lyrics",
" download-lyrics",
" lyrics-scraping",
" japanese-songs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7fef8ada793a6c019ab7cff34bddbdecdb732aae5728cbdb55603e2e8e186732",
"md5": "bbd2dc23c9ad319e1165c8c8af4f9288",
"sha256": "32b1517bd4415fec5515d0c979833e8650eba65481adad5dde558f6bb12fbd2f"
},
"downloads": -1,
"filename": "pyjlyric-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bbd2dc23c9ad319e1165c8c8af4f9288",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9",
"size": 33377,
"upload_time": "2024-12-22T15:47:03",
"upload_time_iso_8601": "2024-12-22T15:47:03.953414Z",
"url": "https://files.pythonhosted.org/packages/7f/ef/8ada793a6c019ab7cff34bddbdecdb732aae5728cbdb55603e2e8e186732/pyjlyric-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76810a7a06c92e0c25ec405bf0e9edb11d203a334aec3d0fb74e7739c689374a",
"md5": "b77d8eaa3a4e48e59bd14c74c4a468c1",
"sha256": "3c3ffc2eaeb00cddd3b2eda1efd0180e120c7bba183783780968ab799181ba4e"
},
"downloads": -1,
"filename": "pyjlyric-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "b77d8eaa3a4e48e59bd14c74c4a468c1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 17697,
"upload_time": "2024-12-22T15:47:06",
"upload_time_iso_8601": "2024-12-22T15:47:06.365128Z",
"url": "https://files.pythonhosted.org/packages/76/81/0a7a06c92e0c25ec405bf0e9edb11d203a334aec3d0fb74e7739c689374a/pyjlyric-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-22 15:47:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "eggplants",
"github_project": "pyjlyric",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyjlyric"
}