xpinyin


Namexpinyin JSON
Version 0.7.6 PyPI version JSON
download
home_pagehttps://github.com/lxneng/xpinyin
SummaryTranslate Chinese hanzi to pinyin (拼音) by Python, 汉字转拼音
upload_time2020-12-21 07:58:32
maintainer
docs_urlNone
authorEric Lo
requires_python
licenseBSD
keywords pinyin
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            xpinyin
==========

Translate Chinese hanzi to pinyin (拼音) by Python, 汉字转拼音

.. image:: https://github.com/lxneng/xpinyin/workflows/Tests/badge.svg
   :target: https://github.com/lxneng/xpinyin/actions?query=workflow%3ATests

.. image:: https://img.shields.io/travis/lxneng/xpinyin.svg
    :target: https://travis-ci.org/lxneng/xpinyin

.. image:: https://img.shields.io/pypi/v/xpinyin.svg
    :target: https://pypi.python.org/pypi/xpinyin/

.. image:: https://img.shields.io/pypi/dm/xpinyin.svg
    :target: https://pypi.python.org/pypi/xpinyin/


Install
----------

Python version >= 3.6

.. code-block:: python

    pip install -U xpinyin


Python version < 3.6

.. code-block:: python

    pip install xpinyin==0.5.7


Usage
-----

.. code-block:: python

    >>> from xpinyin import Pinyin
    >>> p = Pinyin()
    >>> # default splitter is `-`
    >>> p.get_pinyin("上海")
    'shang-hai'
    >>> # show tone marks
    >>> p.get_pinyin("上海", tone_marks='marks')
    'shàng-hǎi'
    >>> p.get_pinyin("上海", tone_marks='numbers')
    >>> 'shang4-hai3'
    >>> # remove splitter
    >>> p.get_pinyin("上海", '')
    'shanghai'
    >>> # set splitter as whitespace
    >>> p.get_pinyin("上海", ' ')
    'shang hai'
    >>> p.get_initial("上")
    'S'
    >>> p.get_initials("上海")
    'S-H'
    >>> p.get_initials("上海", '')
    'SH'
    >>> p.get_initials("上海", ' ')
    'S H'
    >>> # get_initials with retroflex, #39
    >>> p.get_initials("上海", splitter='-', with_retroflex=True)
    'SH-H'
    >>> # New in version 0.7.0, get combinations of the multiple readings of the characters
    >>> p.get_pinyins('模型', splitter=' ', tone_marks='marks')
    ['mó xíng', 'mú xíng']
    >>> p.get_pinyins('模样', splitter=' ', tone_marks='marks')
    ['mó yáng', 'mó yàng', 'mó xiàng', 'mú yáng', 'mú yàng', 'mú xiàng']


Changelog
=========

0.7.6 - Dec. 21, 2020
----------------------

- Fix typing of the Pinyin's data_path argument
  https://github.com/lxneng/xpinyin/pull/53

0.7.5 - Dec. 21, 2020
----------------------

- fix py2 compatible versions

0.7.4 - Dec. 15, 2020
----------------------

- update install doc in readme

0.7.3 - Dec. 14, 2020
----------------------

- fix github actions status icon

0.7.2 - Dec. 14, 2020
----------------------

- Improve func `get_initials`, added with retroflex options, resolve #39
- Better testing
  https://github.com/lxneng/xpinyin/pull/50

0.7.0 - Dec. 13, 2020
----------------------

- Modernize Python versions, 3.6 - 3.9

  https://github.com/lxneng/xpinyin/pull/47
  https://github.com/lxneng/xpinyin/pull/48
  https://github.com/lxneng/xpinyin/pull/49

0.6.0 - Dec. 11, 2020
----------------------

- Add pinyin combinations.
  https://github.com/lxneng/xpinyin/pull/46

0.5.7 - Jun. 28, 2020
----------------------

- fixes #36, #37

0.5.6 - Oct. 15, 2018
----------------------
- add tones as numbers support.
  https://github.com/lxneng/xpinyin/pull/42
- fix tests


0.5.5 - Feb. 28, 2016
----------------------
- add a new staticmethod which can convert pinyin to upper, lower or capitalize.
  https://github.com/lxneng/xpinyin/pull/28

- Removed extraneous "!" being appended to non 'a' vowel replacements when show_tone_marks=True; also added simple unitest.main() for non-nose users
  https://github.com/lxneng/xpinyin/pull/30


0.5.4 - Dec. 14, 2015
----------------------

- replace open() calls with io.open() for Python 3 compatibility,
  fix `UnicodeDecodeError`
- change \u730E 猎 to LIE4
- improve readme


0.5.3 - Dec. 25, 2014
----------------------

- adjust default pinyin for character '什' and '么', 什么 => 'shén-me'


0.5.2 - Jul. 6, 2014
----------------------

- 修复一些常用字的拼音标注

0.4.9 - Oct. 25, 2013
----------------------

- change README and get_initials; add get_initial
  [tangsty]


0.4.8 - Jun. 16, 2013
----------------------

- change README and get_initials; add get_initial
  [tangsty]

- add download status image to README.rst
  [lxneng]

- add travis status image to README.rst
  [lxneng]

- add .travis.yml
  [lxneng]

- 添加测试
  [lxneng]

- 解决翻译中英文混合句子问题
  [lxneng]



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/lxneng/xpinyin",
    "name": "xpinyin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "pinyin",
    "author": "Eric Lo",
    "author_email": "lxneng@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/16/f2/d548d2f91106644b1b51df4cc59c1b3fabe9048954f18011775250c32d53/xpinyin-0.7.6.tar.gz",
    "platform": "",
    "description": "xpinyin\n==========\n\nTranslate Chinese hanzi to pinyin (\u62fc\u97f3) by Python, \u6c49\u5b57\u8f6c\u62fc\u97f3\n\n.. image:: https://github.com/lxneng/xpinyin/workflows/Tests/badge.svg\n   :target: https://github.com/lxneng/xpinyin/actions?query=workflow%3ATests\n\n.. image:: https://img.shields.io/travis/lxneng/xpinyin.svg\n    :target: https://travis-ci.org/lxneng/xpinyin\n\n.. image:: https://img.shields.io/pypi/v/xpinyin.svg\n    :target: https://pypi.python.org/pypi/xpinyin/\n\n.. image:: https://img.shields.io/pypi/dm/xpinyin.svg\n    :target: https://pypi.python.org/pypi/xpinyin/\n\n\nInstall\n----------\n\nPython version >= 3.6\n\n.. code-block:: python\n\n    pip install -U xpinyin\n\n\nPython version < 3.6\n\n.. code-block:: python\n\n    pip install xpinyin==0.5.7\n\n\nUsage\n-----\n\n.. code-block:: python\n\n    >>> from xpinyin import Pinyin\n    >>> p = Pinyin()\n    >>> # default splitter is `-`\n    >>> p.get_pinyin(\"\u4e0a\u6d77\")\n    'shang-hai'\n    >>> # show tone marks\n    >>> p.get_pinyin(\"\u4e0a\u6d77\", tone_marks='marks')\n    'sh\u00e0ng-h\u01cei'\n    >>> p.get_pinyin(\"\u4e0a\u6d77\", tone_marks='numbers')\n    >>> 'shang4-hai3'\n    >>> # remove splitter\n    >>> p.get_pinyin(\"\u4e0a\u6d77\", '')\n    'shanghai'\n    >>> # set splitter as whitespace\n    >>> p.get_pinyin(\"\u4e0a\u6d77\", ' ')\n    'shang hai'\n    >>> p.get_initial(\"\u4e0a\")\n    'S'\n    >>> p.get_initials(\"\u4e0a\u6d77\")\n    'S-H'\n    >>> p.get_initials(\"\u4e0a\u6d77\", '')\n    'SH'\n    >>> p.get_initials(\"\u4e0a\u6d77\", ' ')\n    'S H'\n    >>> # get_initials with retroflex, #39\n    >>> p.get_initials(\"\u4e0a\u6d77\", splitter='-', with_retroflex=True)\n    'SH-H'\n    >>> # New in version 0.7.0, get combinations of the multiple readings of the characters\n    >>> p.get_pinyins('\u6a21\u578b', splitter=' ', tone_marks='marks')\n    ['m\u00f3 x\u00edng', 'm\u00fa x\u00edng']\n    >>> p.get_pinyins('\u6a21\u6837', splitter=' ', tone_marks='marks')\n    ['m\u00f3 y\u00e1ng', 'm\u00f3 y\u00e0ng', 'm\u00f3 xi\u00e0ng', 'm\u00fa y\u00e1ng', 'm\u00fa y\u00e0ng', 'm\u00fa xi\u00e0ng']\n\n\nChangelog\n=========\n\n0.7.6 - Dec. 21, 2020\n----------------------\n\n- Fix typing of the Pinyin's data_path argument\n  https://github.com/lxneng/xpinyin/pull/53\n\n0.7.5 - Dec. 21, 2020\n----------------------\n\n- fix py2 compatible versions\n\n0.7.4 - Dec. 15, 2020\n----------------------\n\n- update install doc in readme\n\n0.7.3 - Dec. 14, 2020\n----------------------\n\n- fix github actions status icon\n\n0.7.2 - Dec. 14, 2020\n----------------------\n\n- Improve func `get_initials`, added with retroflex options, resolve #39\n- Better testing\n  https://github.com/lxneng/xpinyin/pull/50\n\n0.7.0 - Dec. 13, 2020\n----------------------\n\n- Modernize Python versions, 3.6 - 3.9\n\n  https://github.com/lxneng/xpinyin/pull/47\n  https://github.com/lxneng/xpinyin/pull/48\n  https://github.com/lxneng/xpinyin/pull/49\n\n0.6.0 - Dec. 11, 2020\n----------------------\n\n- Add pinyin combinations.\n  https://github.com/lxneng/xpinyin/pull/46\n\n0.5.7 - Jun. 28, 2020\n----------------------\n\n- fixes #36, #37\n\n0.5.6 - Oct. 15, 2018\n----------------------\n- add tones as numbers support.\n  https://github.com/lxneng/xpinyin/pull/42\n- fix tests\n\n\n0.5.5 - Feb. 28, 2016\n----------------------\n- add a new staticmethod which can convert pinyin to upper, lower or capitalize.\n  https://github.com/lxneng/xpinyin/pull/28\n\n- Removed extraneous \"!\" being appended to non 'a' vowel replacements when show_tone_marks=True; also added simple unitest.main() for non-nose users\n  https://github.com/lxneng/xpinyin/pull/30\n\n\n0.5.4 - Dec. 14, 2015\n----------------------\n\n- replace open() calls with io.open() for Python 3 compatibility,\n  fix `UnicodeDecodeError`\n- change \\u730E \u730e to LIE4\n- improve readme\n\n\n0.5.3 - Dec. 25, 2014\n----------------------\n\n- adjust default pinyin for character '\u4ec0' and '\u4e48', \u4ec0\u4e48 => 'sh\u00e9n-me'\n\n\n0.5.2 - Jul. 6, 2014\n----------------------\n\n- \u4fee\u590d\u4e00\u4e9b\u5e38\u7528\u5b57\u7684\u62fc\u97f3\u6807\u6ce8\n\n0.4.9 - Oct. 25, 2013\n----------------------\n\n- change README and get_initials; add get_initial\n  [tangsty]\n\n\n0.4.8 - Jun. 16, 2013\n----------------------\n\n- change README and get_initials; add get_initial\n  [tangsty]\n\n- add download status image to README.rst\n  [lxneng]\n\n- add travis status image to README.rst\n  [lxneng]\n\n- add .travis.yml\n  [lxneng]\n\n- \u6dfb\u52a0\u6d4b\u8bd5\n  [lxneng]\n\n- \u89e3\u51b3\u7ffb\u8bd1\u4e2d\u82f1\u6587\u6df7\u5408\u53e5\u5b50\u95ee\u9898\n  [lxneng]\n\n\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "Translate Chinese hanzi to pinyin (\u62fc\u97f3) by Python, \u6c49\u5b57\u8f6c\u62fc\u97f3",
    "version": "0.7.6",
    "split_keywords": [
        "pinyin"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a53040e099a8da32105c8adf996abe92a5bbf5ecd338de2c4cc491b5718299ce",
                "md5": "4021d8d822fe7433f2f00ec6fb0a058e",
                "sha256": "1d78eac9f612c20e155d7c3eb9dd7f9d3ec4e2667c52049e990b8bd036171a52"
            },
            "downloads": -1,
            "filename": "xpinyin-0.7.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4021d8d822fe7433f2f00ec6fb0a058e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 129510,
            "upload_time": "2020-12-21T07:58:30",
            "upload_time_iso_8601": "2020-12-21T07:58:30.320186Z",
            "url": "https://files.pythonhosted.org/packages/a5/30/40e099a8da32105c8adf996abe92a5bbf5ecd338de2c4cc491b5718299ce/xpinyin-0.7.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "16f2d548d2f91106644b1b51df4cc59c1b3fabe9048954f18011775250c32d53",
                "md5": "a862211dc1382614d48a7c8ff7497343",
                "sha256": "dec6aa0f4d9f9b6788d8131245293f1951180333a6d474b467b2d556221862fe"
            },
            "downloads": -1,
            "filename": "xpinyin-0.7.6.tar.gz",
            "has_sig": false,
            "md5_digest": "a862211dc1382614d48a7c8ff7497343",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 131664,
            "upload_time": "2020-12-21T07:58:32",
            "upload_time_iso_8601": "2020-12-21T07:58:32.453892Z",
            "url": "https://files.pythonhosted.org/packages/16/f2/d548d2f91106644b1b51df4cc59c1b3fabe9048954f18011775250c32d53/xpinyin-0.7.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-12-21 07:58:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "lxneng",
    "github_project": "xpinyin",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "xpinyin"
}
        
Elapsed time: 0.03681s