# gchar
[](https://pypi.org/project/gchar/)
[](https://huggingface.co/datasets/deepghs/game_characters)
[](https://github.com/narugo1992/gchar/actions?query=workflow%3A%22Code+Test%22)
[](https://github.com/narugo1992/gchar/actions/workflows/data.yml)
[](https://github.com/narugo1992/gchar/actions?query=workflow%3A%22Package+Release%22)
[](https://codecov.io/gh/narugo1992/gchar)
[](https://github.com/narugo1992/gchar/stargazers)
[](https://github.com/narugo1992/gchar/network)
[](https://github.com/narugo1992/gchar/issues)
[](https://github.com/narugo1992/gchar/pulls)
[](https://github.com/narugo1992/gchar/graphs/contributors)
[](https://github.com/narugo1992/gchar/blob/master/LICENSE)
Database of known game characters. The database is refreshed once a day, hosted
on [huggingface - deepghs/game_characters](https://huggingface.co/datasets/deepghs/game_characters).
## Installation
You can install `gchar` with pip
```shell
pip install gchar
```
## Quick Start
### Game Character Query
Find the characters (nicknames are supported for arknights and fgo)
Currently Supported Games (If you need data of other games,
you can [create an issue](https://github.com/narugo1992/gchar/issues/new)):
* Arknights (crawled from [PRTS Wiki](https://prts.wiki))
* Fate/Grand Order (crawled from [FGO Wiki](https://fgo.wiki))
* Azur Lane (crawled from [BiliGame Wiki](https://wiki.biligame.com/blhx))
* Girls' Front-Line (crawled from [IOPWiki](https://iopwiki.com/))
* Genshin Impact (crawled from [Fandom](https://genshin-impact.fandom.com/ja/wiki/%E5%8E%9F%E7%A5%9E_Wiki))
* Neural Cloud (crawled from [42lab wiki](http://wiki.42lab.cloud))
* Blue Archive (crawled from [bluearchive wiki](https://bluearchive.wiki/) and [Gamekee BA](https://ba.gamekee.com))
* Nikke: Goddess of Victory (crawled from [Fandom](https://nikke-goddess-of-victory-international.fandom.com)
and [Gamekee Nikke](https://nikke.gamekee.com))
* Path To Nowhere (crawled from [BiliGame Wiki](https://wiki.biligame.com/wqmt))
* Honkai: Star Rail (crawled from [Star Rail Station](https://starrailstation.com)
and [BiliGame Wiki](https://wiki.biligame.com))
```
>>> from gchar.games import get_character
>>>
>>> get_character('amiya') # english name
<Character R001 - 阿米娅/amiya/アーミヤ, female, 5*****>
>>> get_character('z18')
<Character 346 - Z18/hans_ludemann/ハンス・リューデマン, 稀有(2**), group: Group.KMS>
>>> get_character('416')
<Character 65 - HK416/416/416, 5*****, clazz: Clazz.AR>
>>>
>>> get_character('夕') # chinese name
<Character NM02 - 夕/dusk/シー, female, 6******>
>>> get_character('宵宫')
<Character 宵宫/yoimiya/宵宮/よいみや, female, 5*****, weapon: Weapon.BOW, element: Element.PYRO>
>>>
>>> get_character('スルト') # japanese name
<Character R111 - 史尔特尔/surtr/スルト, female, 6******>
>>>
>>> get_character('CEO') # alias
<Character 171 - 彭忒西勒亚/黄金国的Berserker/penthesilea/berserker_of_el_dorado/ペンテシレイア/エルドラドのバーサーカー, female, 4****, class: Clazz.BERSERKER>
>>> get_character('黑呆')
<Character 3 - 阿尔托莉雅·潘德拉贡〔Alter〕/altria_pendragon_alter/アルトリア・ペンドラゴン〔オルタ〕/アルトリア・ペンドラゴン・オルタ/アルトリア・オルタ, female, 4****, class: Clazz.SABER>
>>> get_character('小火龙')
<Character RL03 - 伊芙利特/ifrit/イフリータ, female, 6******>
```
List all character with specific condition of one game
```python
from gchar.games.arknights import Character
for ch in Character.all(): # 5star, boys
if ch.rarity == 5 and ch.gender == 'male':
print(ch)
```
### Pixiv Resources
Get search keywords for pixiv
```
>>> from gchar.resources.pixiv import get_pixiv_keywords
>>>
>>> get_pixiv_keywords('CEO')
'Fate/GrandOrder (berserker_of_el_dorado OR penthesilea OR エルドラドのバーサーカー OR ペンテシレイア OR 彭忒西勒亚 OR 黄金国的berserker)'
>>> get_pixiv_keywords('黑贞')
'Fate/GrandOrder (jeanne_d_arc_alter OR ジャンヌ・ダルク〔オルタ〕 OR 贞德〔alter〕) -jeanne_d_arc_alter_santa_lily'
>>> get_pixiv_keywords('amiya')
'アークナイツ (amiya OR アーミヤ OR 阿米娅)'
>>> get_pixiv_keywords('blazer') # fuzzy match is supported
'アークナイツ (blaze OR ブレイズ OR 煌)'
>>> get_pixiv_keywords('林雨霞')
'アークナイツ (lin OR 林) -angelina -flint -folinic -ling -守林人 -巡林者 -杜林'
>>> get_pixiv_keywords('夕')
'アークナイツ (dusk OR シー OR 夕) -ケルシー -シージ -シーン'
```
See how many posts on pixiv
```
>>> from gchar.resources.pixiv import get_pixiv_posts
>>>
>>> # first one is all, second one is r18
>>> get_pixiv_posts('CEO')
(867, 113)
>>> get_pixiv_posts('黑贞')
(21908, 3820)
>>> get_pixiv_posts('amiya')
(14130, 1113)
>>> get_pixiv_posts('blazer') # fuzzy match is supported, but slower
(1967, 383)
>>> get_pixiv_posts('林雨霞')
(259, 44)
>>> get_pixiv_posts('夕')
(2908, 424)
```
### Other Sites' Resource
Get tags for danbooru and other sites
Currently supported sites:
* [Anime Pictures](https://anime-pictures.net), named `anime_pictures`
* [Atfbooru](https://booru.allthefallen.moe), named `atfbooru`
* [Sankaku](https://chan.sankakucomplex.com), named `sankaku`
* [Danbooru](https://danbooru.donmai.us), named `danbooru`
* [Hypnohub](https://hypnohub.net), named `hypnohub`
* [Konachan](https://konachan.com), named `konachan`
* [Konachan.Net](https://konachan.net), named `konachan_net`
* [Lolibooru](https://lolibooru.moe), named `lolibooru`
* [Rule34](https://rule34.xxx), named `rule34`
* [Safebooru](https://safebooru.donmai.us), named `safebooru`
* [Xbooru](https://xbooru.com), named `xbooru`
* [Yande](https://yande.re), named `yande`
* [Zerochan](https://zerochan.net), named `zerochan`
* [WallHaven](https://wallhaven.cc), named `wallhaven` (`id:xxxx` will be used for explicit searching)
```
>>> from gchar.resources.sites import get_site_tag
>>>
>>> # first one is all, second one is r18
>>> get_site_tag('CEO', 'danbooru')
'penthesilea_(fate)'
>>> get_site_tag('黑贞', 'danbooru')
"jeanne_d'arc_alter_(fate)"
>>> get_site_tag('amiya', 'danbooru')
'amiya_(arknights)'
>>> get_site_tag('林雨霞', 'danbooru')
'lin_(arknights)'
>>> get_site_tag('夕', 'danbooru')
'dusk_(arknights)'
>>> get_site_tag('夕', 'danbooru', with_posts=True) # see how many images
('dusk_(arknights)', 1397)
>>> get_site_tag('夕', 'zerochan') # another sites
'Dusk (Arknights)'
```
## FAQ
Q: How timely is the data?
A: The data is updated approximately once a day and is hosted on Github Action, ensuring its timeliness. In the event of
a malfunction on the crawled Wiki site that prevents data updates, the corresponding Wiki team will be contacted to
resolve the issue.
Raw data
{
"_id": null,
"home_page": "https://github.com/narugo1992/gchar",
"name": "gchar",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "A simple tool for automatic parameter tuning.",
"author": "narugo1992",
"author_email": "narugo@126.com",
"download_url": "https://files.pythonhosted.org/packages/7e/17/c1d28330cce1db1cba29f49546e32a5b30b4987b7c3fff1951f1ddb9462a/gchar-0.1.1.tar.gz",
"platform": null,
"description": "# gchar\n\n[](https://pypi.org/project/gchar/)\n\n\n\n[](https://huggingface.co/datasets/deepghs/game_characters)\n\n[](https://github.com/narugo1992/gchar/actions?query=workflow%3A%22Code+Test%22)\n[](https://github.com/narugo1992/gchar/actions/workflows/data.yml)\n[](https://github.com/narugo1992/gchar/actions?query=workflow%3A%22Package+Release%22)\n[](https://codecov.io/gh/narugo1992/gchar)\n\n\n[](https://github.com/narugo1992/gchar/stargazers)\n[](https://github.com/narugo1992/gchar/network)\n\n[](https://github.com/narugo1992/gchar/issues)\n[](https://github.com/narugo1992/gchar/pulls)\n[](https://github.com/narugo1992/gchar/graphs/contributors)\n[](https://github.com/narugo1992/gchar/blob/master/LICENSE)\n\nDatabase of known game characters. The database is refreshed once a day, hosted\non [huggingface - deepghs/game_characters](https://huggingface.co/datasets/deepghs/game_characters).\n\n## Installation\n\nYou can install `gchar` with pip\n\n```shell\npip install gchar\n```\n\n## Quick Start\n\n### Game Character Query\n\nFind the characters (nicknames are supported for arknights and fgo)\n\nCurrently Supported Games (If you need data of other games,\nyou can [create an issue](https://github.com/narugo1992/gchar/issues/new)):\n\n* Arknights (crawled from [PRTS Wiki](https://prts.wiki))\n* Fate/Grand Order (crawled from [FGO Wiki](https://fgo.wiki))\n* Azur Lane (crawled from [BiliGame Wiki](https://wiki.biligame.com/blhx))\n* Girls' Front-Line (crawled from [IOPWiki](https://iopwiki.com/))\n* Genshin Impact (crawled from [Fandom](https://genshin-impact.fandom.com/ja/wiki/%E5%8E%9F%E7%A5%9E_Wiki))\n* Neural Cloud (crawled from [42lab wiki](http://wiki.42lab.cloud))\n* Blue Archive (crawled from [bluearchive wiki](https://bluearchive.wiki/) and [Gamekee BA](https://ba.gamekee.com))\n* Nikke: Goddess of Victory (crawled from [Fandom](https://nikke-goddess-of-victory-international.fandom.com)\n and [Gamekee Nikke](https://nikke.gamekee.com))\n* Path To Nowhere (crawled from [BiliGame Wiki](https://wiki.biligame.com/wqmt))\n* Honkai: Star Rail (crawled from [Star Rail Station](https://starrailstation.com)\n and [BiliGame Wiki](https://wiki.biligame.com))\n\n```\n>>> from gchar.games import get_character\n>>> \n>>> get_character('amiya') # english name\n<Character R001 - \u963f\u7c73\u5a05/amiya/\u30a2\u30fc\u30df\u30e4, female, 5*****>\n>>> get_character('z18')\n<Character 346 - Z18/hans_ludemann/\u30cf\u30f3\u30b9\u30fb\u30ea\u30e5\u30fc\u30c7\u30de\u30f3, \u7a00\u6709(2**), group: Group.KMS>\n>>> get_character('416')\n<Character 65 - HK416/416/416, 5*****, clazz: Clazz.AR>\n>>> \n>>> get_character('\u5915') # chinese name\n<Character NM02 - \u5915/dusk/\u30b7\u30fc, female, 6******>\n>>> get_character('\u5bb5\u5bab')\n<Character \u5bb5\u5bab/yoimiya/\u5bb5\u5bae/\u3088\u3044\u307f\u3084, female, 5*****, weapon: Weapon.BOW, element: Element.PYRO>\n>>> \n>>> get_character('\u30b9\u30eb\u30c8') # japanese name\n<Character R111 - \u53f2\u5c14\u7279\u5c14/surtr/\u30b9\u30eb\u30c8, female, 6******>\n>>> \n>>> get_character('CEO') # alias\n<Character 171 - \u5f6d\u5fd2\u897f\u52d2\u4e9a/\u9ec4\u91d1\u56fd\u7684Berserker/penthesilea/berserker_of_el_dorado/\u30da\u30f3\u30c6\u30b7\u30ec\u30a4\u30a2/\u30a8\u30eb\u30c9\u30e9\u30c9\u306e\u30d0\u30fc\u30b5\u30fc\u30ab\u30fc, female, 4****, class: Clazz.BERSERKER>\n>>> get_character('\u9ed1\u5446')\n<Character 3 - \u963f\u5c14\u6258\u8389\u96c5\u00b7\u6f58\u5fb7\u62c9\u8d21\u3014Alter\u3015/altria_pendragon_alter/\u30a2\u30eb\u30c8\u30ea\u30a2\u30fb\u30da\u30f3\u30c9\u30e9\u30b4\u30f3\u3014\u30aa\u30eb\u30bf\u3015/\u30a2\u30eb\u30c8\u30ea\u30a2\u30fb\u30da\u30f3\u30c9\u30e9\u30b4\u30f3\u30fb\u30aa\u30eb\u30bf/\u30a2\u30eb\u30c8\u30ea\u30a2\u30fb\u30aa\u30eb\u30bf, female, 4****, class: Clazz.SABER>\n>>> get_character('\u5c0f\u706b\u9f99')\n<Character RL03 - \u4f0a\u8299\u5229\u7279/ifrit/\u30a4\u30d5\u30ea\u30fc\u30bf, female, 6******>\n```\n\nList all character with specific condition of one game\n\n```python\nfrom gchar.games.arknights import Character\n\nfor ch in Character.all(): # 5star, boys\n if ch.rarity == 5 and ch.gender == 'male':\n print(ch)\n\n```\n\n### Pixiv Resources\n\nGet search keywords for pixiv\n\n```\n>>> from gchar.resources.pixiv import get_pixiv_keywords\n>>> \n>>> get_pixiv_keywords('CEO')\n'Fate/GrandOrder (berserker_of_el_dorado OR penthesilea OR \u30a8\u30eb\u30c9\u30e9\u30c9\u306e\u30d0\u30fc\u30b5\u30fc\u30ab\u30fc OR \u30da\u30f3\u30c6\u30b7\u30ec\u30a4\u30a2 OR \u5f6d\u5fd2\u897f\u52d2\u4e9a OR \u9ec4\u91d1\u56fd\u7684berserker)'\n>>> get_pixiv_keywords('\u9ed1\u8d1e')\n'Fate/GrandOrder (jeanne_d_arc_alter OR \u30b8\u30e3\u30f3\u30cc\u30fb\u30c0\u30eb\u30af\u3014\u30aa\u30eb\u30bf\u3015 OR \u8d1e\u5fb7\u3014alter\u3015) -jeanne_d_arc_alter_santa_lily'\n>>> get_pixiv_keywords('amiya')\n'\u30a2\u30fc\u30af\u30ca\u30a4\u30c4 (amiya OR \u30a2\u30fc\u30df\u30e4 OR \u963f\u7c73\u5a05)'\n>>> get_pixiv_keywords('blazer') # fuzzy match is supported\n'\u30a2\u30fc\u30af\u30ca\u30a4\u30c4 (blaze OR \u30d6\u30ec\u30a4\u30ba OR \u714c)'\n>>> get_pixiv_keywords('\u6797\u96e8\u971e')\n'\u30a2\u30fc\u30af\u30ca\u30a4\u30c4 (lin OR \u6797) -angelina -flint -folinic -ling -\u5b88\u6797\u4eba -\u5de1\u6797\u8005 -\u675c\u6797'\n>>> get_pixiv_keywords('\u5915')\n'\u30a2\u30fc\u30af\u30ca\u30a4\u30c4 (dusk OR \u30b7\u30fc OR \u5915) -\u30b1\u30eb\u30b7\u30fc -\u30b7\u30fc\u30b8 -\u30b7\u30fc\u30f3'\n```\n\nSee how many posts on pixiv\n\n```\n>>> from gchar.resources.pixiv import get_pixiv_posts\n>>> \n>>> # first one is all, second one is r18\n>>> get_pixiv_posts('CEO')\n(867, 113)\n>>> get_pixiv_posts('\u9ed1\u8d1e')\n(21908, 3820)\n>>> get_pixiv_posts('amiya')\n(14130, 1113)\n>>> get_pixiv_posts('blazer') # fuzzy match is supported, but slower\n(1967, 383)\n>>> get_pixiv_posts('\u6797\u96e8\u971e')\n(259, 44)\n>>> get_pixiv_posts('\u5915')\n(2908, 424)\n```\n\n### Other Sites' Resource\n\nGet tags for danbooru and other sites\n\nCurrently supported sites:\n\n* [Anime Pictures](https://anime-pictures.net), named `anime_pictures`\n* [Atfbooru](https://booru.allthefallen.moe), named `atfbooru`\n* [Sankaku](https://chan.sankakucomplex.com), named `sankaku`\n* [Danbooru](https://danbooru.donmai.us), named `danbooru`\n* [Hypnohub](https://hypnohub.net), named `hypnohub`\n* [Konachan](https://konachan.com), named `konachan`\n* [Konachan.Net](https://konachan.net), named `konachan_net`\n* [Lolibooru](https://lolibooru.moe), named `lolibooru`\n* [Rule34](https://rule34.xxx), named `rule34`\n* [Safebooru](https://safebooru.donmai.us), named `safebooru`\n* [Xbooru](https://xbooru.com), named `xbooru`\n* [Yande](https://yande.re), named `yande`\n* [Zerochan](https://zerochan.net), named `zerochan`\n* [WallHaven](https://wallhaven.cc), named `wallhaven` (`id:xxxx` will be used for explicit searching)\n\n```\n>>> from gchar.resources.sites import get_site_tag\n>>> \n>>> # first one is all, second one is r18\n>>> get_site_tag('CEO', 'danbooru')\n'penthesilea_(fate)'\n>>> get_site_tag('\u9ed1\u8d1e', 'danbooru')\n\"jeanne_d'arc_alter_(fate)\"\n>>> get_site_tag('amiya', 'danbooru')\n'amiya_(arknights)'\n>>> get_site_tag('\u6797\u96e8\u971e', 'danbooru')\n'lin_(arknights)'\n>>> get_site_tag('\u5915', 'danbooru')\n'dusk_(arknights)'\n>>> get_site_tag('\u5915', 'danbooru', with_posts=True) # see how many images\n('dusk_(arknights)', 1397)\n>>> get_site_tag('\u5915', 'zerochan') # another sites\n'Dusk (Arknights)'\n```\n\n## FAQ\n\nQ: How timely is the data?\n\nA: The data is updated approximately once a day and is hosted on Github Action, ensuring its timeliness. In the event of\na malfunction on the crawled Wiki site that prevents data updates, the corresponding Wiki team will be contacted to\nresolve the issue.\n\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "Game character manager.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/narugo1992/gchar"
},
"split_keywords": [
"a",
"simple",
"tool",
"for",
"automatic",
"parameter",
"tuning."
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5c77dd7efac719e898c64df637b1a0619d59f54942cd22ff390c00893ea357bc",
"md5": "6bce4b6a4f13a0f83214ade208223de6",
"sha256": "5dd2c0851634eb9960b4fefe45a5b5ea49ff28cf47bd41528c5655bec5c27e21"
},
"downloads": -1,
"filename": "gchar-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6bce4b6a4f13a0f83214ade208223de6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 62060,
"upload_time": "2023-07-16T09:50:40",
"upload_time_iso_8601": "2023-07-16T09:50:40.537039Z",
"url": "https://files.pythonhosted.org/packages/5c/77/dd7efac719e898c64df637b1a0619d59f54942cd22ff390c00893ea357bc/gchar-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e17c1d28330cce1db1cba29f49546e32a5b30b4987b7c3fff1951f1ddb9462a",
"md5": "2cf5fbf94681c021125267e4b7e7715b",
"sha256": "4daa2799c4296d573e037715e08ce07abff140ffed5f742c269281e075edb4a4"
},
"downloads": -1,
"filename": "gchar-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "2cf5fbf94681c021125267e4b7e7715b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 45348,
"upload_time": "2023-07-16T09:50:42",
"upload_time_iso_8601": "2023-07-16T09:50:42.729991Z",
"url": "https://files.pythonhosted.org/packages/7e/17/c1d28330cce1db1cba29f49546e32a5b30b4987b7c3fff1951f1ddb9462a/gchar-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-16 09:50:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "narugo1992",
"github_project": "gchar",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "gchar"
}
JSON
