cChardet/README.markdown

cChardet
========
cChardet is high speed universal character encoding detector. - binding to [charsetdetect](https://bitbucket.org/medoc/uchardet-enhanced/overview).

[![Build Status](https://travis-ci.org/PyYoshi/cChardet.svg?branch=master)](https://travis-ci.org/PyYoshi/cChardet)
[![Build status](https://ci.appveyor.com/api/projects/status/lwkc4rgf3gncb1ne/branch/master?svg=true)](https://ci.appveyor.com/project/PyYoshi/cchardet/branch/master)

## Support codecs

- Big5
- EUC-JP
- EUC-KR
- GB18030
- HZ-GB-2312
- IBM855
- IBM866
- ISO-2022-CN
- ISO-2022-JP
- ISO-2022-KR
- ISO-8859-2
- ISO-8859-5
- ISO-8859-7
- ISO-8859-8
- KOI8-R
- Shift_JIS
- TIS-620
- UTF-8
- UTF-16BE
- UTF-16LE
- UTF-32BE
- UTF-32LE
- WINDOWS-1250
- WINDOWS-1251
- WINDOWS-1252
- WINDOWS-1253
- WINDOWS-1255
- EUC-TW
- X-ISO-10646-UCS-4-2143
- X-ISO-10646-UCS-4-3412
- x-mac-cyrillic

## Requires

- Cython: [http://www.cython.org/](http://www.cython.org/)

## Installation

```bash
$ cd /tmp
$ git clone git://github.com/PyYoshi/cChardet.git
$ cd cChardet
$ python setup.py install
```

or

```bash
$ pip install -U cchardet
```

## Example

```python
# -*- coding: utf-8 -*-
import cchardet as chardet
with open(r"src/tests/testdata/wikipediaJa_One_Thousand_and_One_Nights_SJIS.txt", "rb") as f:
    msg = f.read()
    result = chardet.detect(msg)
    print(result)
```

## Benchmark

```bash
$ cd src/
$ pip install chardet
$ python tests/bench.py
```

### Performance

CPU: Intel(R) Core(TM) i3-4170 CPU @ 3.70GHz

RAM: DDR3 1600Mhz 16GB

Platform: Ubuntu 16.04 amd64

#### Python 2.7.12

<table>
  <tr>
    <th></th><th>Request (call/s)</th>
  </tr>
  <tr>
    <td>chardet</td><td>0.26</td>
  </tr>
  <tr>
    <td>cchardet</td><td>1408.73</td>
  </tr>
</table>

#### Python 3.5.2

<table>
  <tr>
    <th></th><th>Request (call/s)</th>
  </tr>
  <tr>
    <td>chardet</td><td>0.28</td>
  </tr>
  <tr>
    <td>cchardet</td><td>1380.40</td>
  </tr>
</table>

## License
* The MIT License: [src/cchardet](https://github.com/PyYoshi/cChardet/tree/master/src/cchardet)

* Other Libraries License: Please, look at the [src/ext](https://github.com/PyYoshi/cChardet/tree/master/src/ext) directory.

## Thanks
* [uchardet-enhanced](https://bitbucket.org/medoc/uchardet-enhanced/overview)

* [Cython](http://www.cython.org/)

## Contact

[Issues](https://github.com/PyYoshi/cChardet/issues?page=1&state=open)