Metadata-Version: 2.1
Name: ckip-classic
Version: 1.0.0
Summary: CKIP Classic NLP Tools
Home-page: https://ckip-classic.readthedocs.io
Author: Mu Yang
Author-email: emfomy@gmail.com
License: CC BY-NC-SA 4.0
Download-URL: https://ckip-classic.readthedocs.io/tarball/1.0.0
Description: Introduction
        ============
        
        .. attention::
           Please use `CKIPNLP <https://pypi.org/project/ckipnlp/>`_ for structured data types and pipeline drivers.
        
        Git
        ---
        
        https://github.com/ckiplab/ckip-classic
        
        |GitHub Version| |GitHub Release| |GitHub Issues|
        
        .. |GitHub Version| image:: https://img.shields.io/github/v/release/ckiplab/ckip-classic.svg?maxAge=3600
           :target: https://github.com/ckiplab/ckip-classic/releases
        
        .. |GitHub License| image:: https://img.shields.io/github/license/ckiplab/ckip-classic.svg?maxAge=3600
           :target: https://github.com/ckiplab/ckip-classic/blob/master/LICENSE
        
        .. |GitHub Release| image:: https://img.shields.io/github/release-date/ckiplab/ckip-classic.svg?maxAge=3600
        
        .. |GitHub Downloads| image:: https://img.shields.io/github/downloads/ckiplab/ckip-classic/total.svg?maxAge=3600
           :target: https://github.com/ckiplab/ckip-classic/releases/latest
        
        .. |GitHub Issues| image:: https://img.shields.io/github/issues/ckiplab/ckip-classic.svg?maxAge=3600
           :target: https://github.com/ckiplab/ckip-classic/issues
        
        .. |GitHub Forks| image:: https://img.shields.io/github/forks/ckiplab/ckip-classic.svg?style=social&label=Fork&maxAge=3600
        
        .. |GitHub Stars| image:: https://img.shields.io/github/stars/ckiplab/ckip-classic.svg?style=social&label=Star&maxAge=3600
        
        .. |GitHub Watchers| image:: https://img.shields.io/github/watchers/ckiplab/ckip-classic.svg?style=social&label=Watch&maxAge=3600
        
        PyPI
        ----
        
        https://pypi.org/project/ckip-classic
        
        |PyPI Version| |PyPI License| |PyPI Downloads| |PyPI Python| |PyPI Implementation| |PyPI Status|
        
        .. |PyPI Version| image:: https://img.shields.io/pypi/v/ckip-classic.svg?maxAge=3600
           :target: https://pypi.org/project/ckip-classic
        
        .. |PyPI License| image:: https://img.shields.io/pypi/l/ckip-classic.svg?maxAge=3600
           :target: https://github.com/ckiplab/ckip-classic/blob/master/LICENSE
        
        .. |PyPI Downloads| image:: https://img.shields.io/pypi/dm/ckip-classic.svg?maxAge=3600
           :target: https://pypi.org/project/ckip-classic#files
        
        .. |PyPI Python| image:: https://img.shields.io/pypi/pyversions/ckip-classic.svg?maxAge=3600
        
        .. |PyPI Implementation| image:: https://img.shields.io/pypi/implementation/ckip-classic.svg?maxAge=3600
        
        .. |PyPI Format| image:: https://img.shields.io/pypi/format/ckip-classic.svg?maxAge=3600
        
        .. |PyPI Status| image:: https://img.shields.io/pypi/status/ckip-classic.svg?maxAge=3600
        
        Documentation
        -------------
        
        https://ckip-classic.readthedocs.io/
        
        |ReadTheDocs Home|
        
        .. |ReadTheDocs Home| image:: https://img.shields.io/website/https/ckip-classic.readthedocs.io.svg?maxAge=3600&up_message=online&down_message=offline
           :target: http://ckip-classic.readthedocs.io
        
        Contributers
        ------------
        
        * `Mu Yang <http://muyang.pro>`_ at `CKIP <https://ckip.iis.sinica.edu.tw>`_ (Author & Maintainer)
        * `Wei-Yun Ma <https://www.iis.sinica.edu.tw/pages/ma/>`_ at `CKIP <https://ckip.iis.sinica.edu.tw>`_ (Maintainer)
        
        External Links
        --------------
        
        - `Online Demo <https://ckip.iis.sinica.edu.tw/service/corenlp>`_
        
        Requirements
        ------------
        
        * `Python <http://www.python.org>`_ 3.5+
        * `Cython <http://cython.org>`_ 0.29+
        
        .. attention::
           For Python 2 users, please use `PyCkip 0.4.2 <https://pypi.org/project/pyckip/0.4.2/>`_ instead.
        
        CKIPWS (Optional)
        ^^^^^^^^^^^^^^^^^
        
        * `CKIP Word Segmentation <http://ckip.iis.sinica.edu.tw/project/wordsegment/>`_ Linux version 20190524+
        
        CKIPParser (Optional)
        ^^^^^^^^^^^^^^^^^^^^^
        
        * `CKIP Parser <http://ckip.iis.sinica.edu.tw/project/parser/>`_ Linux version 20190506+ (20190725+ recommended)
        
        Installation
        ============
        
        Denote ``<ckipws-linux-root>`` as the root path of CKIPWS Linux Version, and ``<ckipparser-linux-root>`` as the root path of CKIPParser Linux Version.
        
        Install Using Pip
        -----------------
        
        .. code-block:: bash
        
           pip install --upgrade ckip-classic
           pip install --no-deps --force-reinstall --upgrade ckip-classic \
              --install-option='--ws' \
              --install-option='--ws-dir=<ckipws-linux-root>' \
              --install-option='--parser' \
              --install-option='--parser-dir=<ckipparser-linux-root>'
        
        Ignore ws/parser options if one doesn't have CKIPWS/CKIPParser.
        
        Installation Options
        --------------------
        
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | Option                                        | Detail                                | Default Value                 |
        +===============================================+=======================================+===============================+
        | ``--[no-]ws``                                 | Enable/disable CKIPWS.                | False                         |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--[no-]parser``                             | Enable/disable CKIPParser.            | False                         |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--ws-dir=<ws-dir>``                         | CKIPWS root directory.                |                               |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--ws-lib-dir=<ws-lib-dir>``                 | CKIPWS libraries directory            | ``<ws-dir>/lib``              |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--ws-share-dir=<ws-share-dir>``             | CKIPWS share directory                | ``<ws-dir>``                  |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--parser-dir=<parser-dir>``                 | CKIPParser root directory.            |                               |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--parser-lib-dir=<parser-lib-dir>``         | CKIPParser libraries directory        | ``<parser-dir>/lib``          |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--parser-share-dir=<parser-share-dir>``     | CKIPParser share directory            | ``<parser-dir>``              |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--data2-dir=<data2-dir>``                   | "Data2" directory                     | ``<ws-share-dir>/Data2``      |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--rule-dir=<rule-dir>``                     | "Rule" directory                      | ``<parser-share-dir>/Rule``   |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        | ``--rdb-dir=<rdb-dir>``                       | "RDB" directory                       | ``<parser-share-dir>/RDB``    |
        +-----------------------------------------------+---------------------------------------+-------------------------------+
        
        Usage
        =====
        
        See http://ckip-classic.readthedocs.io/ for API details.
        
        CKIPWS
        ------
        
        .. code-block:: python
        
           import ckip_classic.ws
           print(ckip_classic.__name__, ckip_classic.__version__)
        
           ws = ckip_classic.ws.CkipWs(logger=False)
           print(ws('中文字喔'))
           for l in ws.apply_list(['中文字喔', '啊哈哈哈']): print(l)
        
           ws.apply_file(ifile='sample/sample.txt', ofile='output/sample.tag', uwfile='output/sample.uw')
           with open('output/sample.tag') as fin:
               print(fin.read())
           with open('output/sample.uw') as fin:
               print(fin.read())
        
        
        CKIPParser
        -----------
        
        .. code-block:: python
        
           import ckip_classic.parser
           print(ckip_classic.__name__, ckip_classic.__version__)
        
           ps = ckip_classic.parser.CkipParser(logger=False)
           print(ps('中文字喔'))
           for l in ps.apply_list(['中文字喔', '啊哈哈哈']): print(l)
        
           ps.apply_file(ifile='sample/sample.txt', ofile='output/sample.tree')
           with open('output/sample.tree') as fin:
               print(fin.read())
        
        
        FAQ
        ===
        
        .. danger::
        
           Due to C code implementation, both ``CkipWs`` and ``CkipParser`` can only be instance once.
        
        ------------
        
        .. warning::
        
           CKIPParser fails if input text contains special characters such as ``()+-:|&#``. One may replace these characters by
        
           .. code-block:: python
        
              text = text
                 .replace('(', '（')
                 .replace(')', '）')
                 .replace('+', '＋')
                 .replace('-', '－')
                 .replace(':', '：')
                 .replace('|', '｜')
                 .replace('&', '＆') # for tree draw
                 .replace('#', '＃') # for tree draw
        
        ------------
        
        .. tip::
        
           **The CKIPWS throws "what():  locale::facet::_S_create_c_locale name not valid". What should I do?**
        
           Install locale data.
        
           .. code-block:: bash
        
              apt-get install locales-all
        
        ------------
        
        .. tip::
        
           **The CKIPParser throws "ImportError: libCKIPParser.so: cannot open shared object file: No such file or directory". What should I do?**
        
           Add below command to ``~/.bashrc``:
        
           .. code-block:: bash
        
              export LD_LIBRARY_PATH=<ckipparser-linux-root>/lib:$LD_LIBRARY_PATH
        
        License
        =======
        
        |CC BY-NC-SA 4.0|
        
        Copyright (c) 2018-2020 `CKIP Lab <https://ckip.iis.sinica.edu.tw>`_ under the `CC BY-NC-SA 4.0 License <http://creativecommons.org/licenses/by-nc-sa/4.0/>`_.
        
        .. |CC BY-NC-SA 4.0| image:: https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png
           :target: http://creativecommons.org/licenses/by-nc-sa/4.0/
        
Platform: linux_x86_64
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Cython
Classifier: License :: Free for non-commercial use
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: Chinese (Traditional)
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
