Skip to content

Latest commit

 

History

History
101 lines (80 loc) · 4.25 KB

README.rst

File metadata and controls

101 lines (80 loc) · 4.25 KB
https://travis-ci.org/cihai/cihai-python.png?branch=master https://badge.fury.io/py/cihai.png https://coveralls.io/repos/cihai/cihai-python/badge.png?branch=master

cihai-python - China fit into a python package.

This project has been split into the https://github.com/cihai group.

This project is being split:

Cihai is a team, effort, united effort for incubating open, permissive, high quality CJK datasets and clients.

  • cihai-handbook provides documentational overviews of the history of CJK, the dataset standards and available client libraries.
  • Official client libraries. cihai-python will be a python client for cihai+datapackages datasets (cjklib style).
  • Public datasets maintained by cihai team. Unihan will be a first example. See cihaidata-unihan.

Attempt at building successor of the Han Character library cjklib.

  • compatible with python 2.7+ and 3.3+.
  • built using TDD and python best practices.
  • supports Unihan, see current datasets.
  • upcoming supports for character decomposition, dictionaries (CEDict).
  • extensible to new datasets, see more about Extending cihai's knowledge.

Being built against unit tests. See the Travis Builds and Revision History.

See Internals for design philosophy.

Future results

  • Future versions will allow deeper introspection into results:
    • Multiple characters words
    • Phrases
    • Mispellings / similar shapes
    • Sorting results by usage, stroke
    • Breaking strings of characters into words
    • More datasets
Python support Python 2.7, >= 3.3
Source https://github.com/cihai/cihai-python
Docs http://cihai.rtfd.org
Changelog http://cihai.readthedocs.org/en/latest/history.html
API http://cihai.readthedocs.org/en/latest/api.html
Issues https://github.com/cihai/cihai-python/issues
Travis http://travis-ci.org/cihai/cihai-python
Test coverage https://coveralls.io/r/cihai/cihai-python
pypi https://pypi.python.org/pypi/cihai
Ohloh https://www.ohloh.net/p/cihai
License BSD.
git repo
$ git clone https://github.com/cihai/cihai-python.git
install dev
$ git clone https://github.com/cihai/cihai-python.git cihai
$ cd ./cihai
$ virtualenv .env
$ source .env/bin/activate
$ pip install -e .
tests
$ python setup.py test