cihai-cli


Namecihai-cli JSON
Version 0.26.0 PyPI version JSON
download
home_pagehttps://cihai-cli.git-pull.com
SummaryCommand line frontend for the cihai CJK language library
upload_time2024-02-09 19:08:33
maintainer
docs_urlNone
authorTony Narlock
requires_python>=3.8,<4.0
licenseMIT
keywords unihan sqlalchemy library cjk unicode dictionary dataset encyclopedia chinese japanese korean languages study cli terminal shell
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cihai-cli &middot; [![Python Package](https://img.shields.io/pypi/v/cihai_cli.svg)](https://pypi.org/project/cihai-cli/) [![License](https://img.shields.io/github/license/cihai/cihai-cli.svg)](https://github.com/cihai/cihai-cli/blob/master/LICENSE) [![Code Coverage](https://codecov.io/gh/cihai/cihai-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/cihai/cihai-cli)

Command line interface to the [cihai](https://cihai.git-pull.com)
[CJK](https://cihai.git-pull.com/glossary.html#term-cjk)-language library.

This project is under active development. Follow our progress and check back for updates!

## Installation

```console
$ pip install --user cihai-cli
```

### Developmental releases

You can test the unpublished version of cihai-cli before its released.

- [pip](https://pip.pypa.io/en/stable/):

  ```console
  $ pip install --user --upgrade --pre cihai-cli
  ```

- [pipx](https://pypa.github.io/pipx/docs/):

  ```console
  $ pipx install --suffix=@next cihai-cli --pip-args '\--pre' --include-deps --force
  ```

  Then use `cihai@next info 好`.

For more information see
[developmental releases](https://cihai-cli.git-pull.com/quickstart.html#developmental-releases)

## Character lookup

See [CLI](https://cihai-cli.git-pull.com/cli.html) in the documentation for full usage information.

```console
$ cihai info 好
```

```yaml
char: 好
kCantonese: hou2 hou3
kDefinition: good, excellent, fine; well
kHangul: 호
kJapaneseOn: KOU
kKorean: HO
kMandarin: hǎo
kTang: "*xɑ̀u *xɑ̌u"
kTotalStrokes: "6"
ucn: U+597D
```

Retrieve all character information (including book indices):

```console
$ cihai info 好 -a
```

```yaml
char: 好
kCangjie: VND
kCantonese: hou2 hou3
kCihaiT: "378.103"
kDefinition: good, excellent, fine; well
kFenn: 552A
kFourCornerCode: "4744.7"
kFrequency: "1"
kGradeLevel: "1"
kHKGlyph: 0871
kHangul: 호
kHanyuPinlu: hǎo(6060) hāo(142) hào(115)
kHanyuPinyin: 21028.010:hǎo,hào
kJapaneseKun: KONOMU SUKU YOI
kJapaneseOn: KOU
kKorean: HO
kMandarin: hǎo
kPhonetic: "481"
kRSAdobe_Japan1_6: C+1975+38.3.3 C+1975+39.3.3
kRSKangXi: "38.3"
kTang: "*xɑ̀u *xɑ̌u"
kTotalStrokes: "6"
kVietnamese: háo
kXHC1983: 0445.030:hǎo 0448.030:hào
ucn: U+597D
```

## Reverse lookup

```console
$ cihai reverse library
```

```yaml
char: 圕
kCantonese: syu1
kDefinition: library
kJapaneseOn: TOSHOKAN SHO
kMandarin: tú
kTotalStrokes: '13'
ucn: U+5715
--------
char: 嫏
kCantonese: long4
kDefinition: the place where the supreme stores his books; library
kJapaneseOn: ROU
kMandarin: láng
kTotalStrokes: '11'
ucn: U+5ACF
--------
```

## Developing

```console
$ git clone https://github.com/cihai/cihai-cli.git
```

```console
$ cd cihai-cli
```

[Bootstrap your environment and learn more about contributing](https://cihai.git-pull.com/contributing/). We use the same conventions / tools across all cihai projects: `pytest`, `sphinx`, `mypy`, `ruff`, `tmuxp`, and file watcher helpers (e.g. `entr(1)`).

## Python versions

- Final Python 3.7 version: 0.16.0

## Quick links

- [Quickstart](https://cihai-cli.git-pull.com/quickstart.html)
- Python [API](https://cihai-cli.git-pull.com/api.html)
- [2017 roadmap](https://cihai.git-pull.com/design-and-planning/2017/spec.html)
- Python support: >= 3.8, pypy
- Source: <https://github.com/cihai/cihai-cli>
- Docs: <https://cihai-cli.git-pull.com>
- Changelog: <https://cihai-cli.git-pull.com/history.html>
- API: <https://cihai-cli.git-pull.com/api.html>
- Issues: <https://github.com/cihai/cihai-cli/issues>
- Test coverage <https://codecov.io/gh/cihai/cihai-cli>
- pypi: <https://pypi.python.org/pypi/cihai-cli>
- OpenHub: <https://www.openhub.net/p/cihai-cli>
- License: MIT

[![Docs](https://github.com/cihai/cihai-cli/workflows/docs/badge.svg)](https://cihai-cli.git-pull.com/)
[![Build Status](https://github.com/cihai/cihai-cli/workflows/tests/badge.svg)](https://github.com/cihai/cihai-cli/actions?query=workflow%3A%22tests%22)


            

Raw data

            {
    "_id": null,
    "home_page": "https://cihai-cli.git-pull.com",
    "name": "cihai-cli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "unihan,sqlalchemy,library,cjk,unicode,dictionary,dataset,encyclopedia,chinese,japanese,korean,languages,study,cli,terminal,shell",
    "author": "Tony Narlock",
    "author_email": "tony@git-pull.com",
    "download_url": "https://files.pythonhosted.org/packages/f7/b7/0d443f182f46677cc4431f912bcbab9f44ee09dbb0238e072e0981819e0b/cihai_cli-0.26.0.tar.gz",
    "platform": null,
    "description": "# cihai-cli &middot; [![Python Package](https://img.shields.io/pypi/v/cihai_cli.svg)](https://pypi.org/project/cihai-cli/) [![License](https://img.shields.io/github/license/cihai/cihai-cli.svg)](https://github.com/cihai/cihai-cli/blob/master/LICENSE) [![Code Coverage](https://codecov.io/gh/cihai/cihai-cli/branch/master/graph/badge.svg)](https://codecov.io/gh/cihai/cihai-cli)\n\nCommand line interface to the [cihai](https://cihai.git-pull.com)\n[CJK](https://cihai.git-pull.com/glossary.html#term-cjk)-language library.\n\nThis project is under active development. Follow our progress and check back for updates!\n\n## Installation\n\n```console\n$ pip install --user cihai-cli\n```\n\n### Developmental releases\n\nYou can test the unpublished version of cihai-cli before its released.\n\n- [pip](https://pip.pypa.io/en/stable/):\n\n  ```console\n  $ pip install --user --upgrade --pre cihai-cli\n  ```\n\n- [pipx](https://pypa.github.io/pipx/docs/):\n\n  ```console\n  $ pipx install --suffix=@next cihai-cli --pip-args '\\--pre' --include-deps --force\n  ```\n\n  Then use `cihai@next info \u597d`.\n\nFor more information see\n[developmental releases](https://cihai-cli.git-pull.com/quickstart.html#developmental-releases)\n\n## Character lookup\n\nSee [CLI](https://cihai-cli.git-pull.com/cli.html) in the documentation for full usage information.\n\n```console\n$ cihai info \u597d\n```\n\n```yaml\nchar: \u597d\nkCantonese: hou2 hou3\nkDefinition: good, excellent, fine; well\nkHangul: \ud638\nkJapaneseOn: KOU\nkKorean: HO\nkMandarin: h\u01ceo\nkTang: \"*x\u0251\u0300u *x\u0251\u030cu\"\nkTotalStrokes: \"6\"\nucn: U+597D\n```\n\nRetrieve all character information (including book indices):\n\n```console\n$ cihai info \u597d -a\n```\n\n```yaml\nchar: \u597d\nkCangjie: VND\nkCantonese: hou2 hou3\nkCihaiT: \"378.103\"\nkDefinition: good, excellent, fine; well\nkFenn: 552A\nkFourCornerCode: \"4744.7\"\nkFrequency: \"1\"\nkGradeLevel: \"1\"\nkHKGlyph: 0871\nkHangul: \ud638\nkHanyuPinlu: h\u01ceo(6060) h\u0101o(142) h\u00e0o(115)\nkHanyuPinyin: 21028.010:h\u01ceo,h\u00e0o\nkJapaneseKun: KONOMU SUKU YOI\nkJapaneseOn: KOU\nkKorean: HO\nkMandarin: h\u01ceo\nkPhonetic: \"481\"\nkRSAdobe_Japan1_6: C+1975+38.3.3 C+1975+39.3.3\nkRSKangXi: \"38.3\"\nkTang: \"*x\u0251\u0300u *x\u0251\u030cu\"\nkTotalStrokes: \"6\"\nkVietnamese: h\u00e1o\nkXHC1983: 0445.030:h\u01ceo 0448.030:h\u00e0o\nucn: U+597D\n```\n\n## Reverse lookup\n\n```console\n$ cihai reverse library\n```\n\n```yaml\nchar: \u5715\nkCantonese: syu1\nkDefinition: library\nkJapaneseOn: TOSHOKAN SHO\nkMandarin: t\u00fa\nkTotalStrokes: '13'\nucn: U+5715\n--------\nchar: \u5acf\nkCantonese: long4\nkDefinition: the place where the supreme stores his books; library\nkJapaneseOn: ROU\nkMandarin: l\u00e1ng\nkTotalStrokes: '11'\nucn: U+5ACF\n--------\n```\n\n## Developing\n\n```console\n$ git clone https://github.com/cihai/cihai-cli.git\n```\n\n```console\n$ cd cihai-cli\n```\n\n[Bootstrap your environment and learn more about contributing](https://cihai.git-pull.com/contributing/). We use the same conventions / tools across all cihai projects: `pytest`, `sphinx`, `mypy`, `ruff`, `tmuxp`, and file watcher helpers (e.g. `entr(1)`).\n\n## Python versions\n\n- Final Python 3.7 version: 0.16.0\n\n## Quick links\n\n- [Quickstart](https://cihai-cli.git-pull.com/quickstart.html)\n- Python [API](https://cihai-cli.git-pull.com/api.html)\n- [2017 roadmap](https://cihai.git-pull.com/design-and-planning/2017/spec.html)\n- Python support: >= 3.8, pypy\n- Source: <https://github.com/cihai/cihai-cli>\n- Docs: <https://cihai-cli.git-pull.com>\n- Changelog: <https://cihai-cli.git-pull.com/history.html>\n- API: <https://cihai-cli.git-pull.com/api.html>\n- Issues: <https://github.com/cihai/cihai-cli/issues>\n- Test coverage <https://codecov.io/gh/cihai/cihai-cli>\n- pypi: <https://pypi.python.org/pypi/cihai-cli>\n- OpenHub: <https://www.openhub.net/p/cihai-cli>\n- License: MIT\n\n[![Docs](https://github.com/cihai/cihai-cli/workflows/docs/badge.svg)](https://cihai-cli.git-pull.com/)\n[![Build Status](https://github.com/cihai/cihai-cli/workflows/tests/badge.svg)](https://github.com/cihai/cihai-cli/actions?query=workflow%3A%22tests%22)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Command line frontend for the cihai CJK language library",
    "version": "0.26.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/cihai/cihai-cli/issues",
        "Documentation": "https://cihai-cli.git-pull.com",
        "Homepage": "https://cihai-cli.git-pull.com",
        "Q & A": "https://github.com/cihai/cihai-cli/discussions",
        "Release notes": "https://github.com/cihai/cihai-cli/blob/master/CHANGES",
        "Repository": "https://github.com/cihai/cihai-cli"
    },
    "split_keywords": [
        "unihan",
        "sqlalchemy",
        "library",
        "cjk",
        "unicode",
        "dictionary",
        "dataset",
        "encyclopedia",
        "chinese",
        "japanese",
        "korean",
        "languages",
        "study",
        "cli",
        "terminal",
        "shell"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d195e24b6625b157c32d93428fd0903a74ad4b3ddde16ca4c14c49f0bd574426",
                "md5": "7c271f652dad55bdb616d4e9ada311bd",
                "sha256": "9311c9c3b341f6a5f3963ad43ef3d9d51a7af605fcb258241321076bb38e9395"
            },
            "downloads": -1,
            "filename": "cihai_cli-0.26.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c271f652dad55bdb616d4e9ada311bd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 6552,
            "upload_time": "2024-02-09T19:08:31",
            "upload_time_iso_8601": "2024-02-09T19:08:31.711971Z",
            "url": "https://files.pythonhosted.org/packages/d1/95/e24b6625b157c32d93428fd0903a74ad4b3ddde16ca4c14c49f0bd574426/cihai_cli-0.26.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f7b70d443f182f46677cc4431f912bcbab9f44ee09dbb0238e072e0981819e0b",
                "md5": "799a9f5374c69cbf4551d607eeca6dad",
                "sha256": "833748e642057e32bfb35eacd194c114e945c813d6ae8911154b494522b68f79"
            },
            "downloads": -1,
            "filename": "cihai_cli-0.26.0.tar.gz",
            "has_sig": false,
            "md5_digest": "799a9f5374c69cbf4551d607eeca6dad",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 14062,
            "upload_time": "2024-02-09T19:08:33",
            "upload_time_iso_8601": "2024-02-09T19:08:33.173566Z",
            "url": "https://files.pythonhosted.org/packages/f7/b7/0d443f182f46677cc4431f912bcbab9f44ee09dbb0238e072e0981819e0b/cihai_cli-0.26.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-09 19:08:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cihai",
    "github_project": "cihai-cli",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "cihai-cli"
}
        
Elapsed time: 0.19887s