emoji-pythonは日本の携帯電話の絵文字を変換するためのPythonライブラリです。

このライブラリは、絵文字バイナリと内部タグの変換を行ないます。

* 絵文字バイナリ => 内部タグ
* 内部タグ => 絵文字バイナリ

の、双方向の変換をサポートしています。

内部タグは `[d123]` のような形式で、キャリアのイニシャルと、絵文字番号を括弧でくくったものです(括弧はオプションで別の文字に変更できます)。

データベースに保管したり、絵文字に対応しないパソコンのブラウザで編集したりしても、情報が失われないようになっています。また、内部タグにはキャリア情報が含まれるため、どのキャリアの絵文字だったかという情報も保持しておけます。

内部タグで保存されたデータを携帯で表示する場合は、内部タグを絵文字バイナリに変換して出力することになります。

インストール
============

ソースコード中のemojiディレクトリを、パスの通った場所に置きます。


使い方
======

絵文字を変換するクラスのインスタンスを生成します。

factory関数を使用します。

	import emoji
	converter = emoji.factory('docomo', 'sjis')

factory関数の第一引数は、キャリア(docomo, ezweb, softbank, pc)です。

第二引数は文字コードです。省略すると sjis になります。

この文字コードはPythonソースコードの内部コードではなく、
インプットおよびアウトプットの文字コードです。

つまり表示するHTMLの文字コードです。

携帯電話から受け取った絵文字バイナリを含む文字列を、
内部タグに変換するには、convertメソッドを使います。

	converted_text = converter.convert(input_text)

内部タグに変換された文字列を、元の絵文字バイナリを含む文字列に変換するには、
restoreメソッドを使います。

	output_text = converter.restore(converted_text)


ライセンス
==========

Apache License 2.0


謝辞
====
このライブラリはPHPの [http://openpear.org/package/Text_Pictogram_Mobile Text_Pictogram_Mobile] をベースに、Pythonに移植を行いました。ありがとうございます。

また、絵文字画像は [http://d.hatena.ne.jp/ryster/20080130/1201708214 MobilePictogramConverter] に同梱されていたものを、そのまま使わせていただいています。ありがとうございます。