misc refine.

1. simplify api
2. update license and readme

Author: lxyu

LICENSE

@@ -1,13 +1,18 @@
-Copyright (c) 2012, Lx Yu
+Copyright (c) 2013, Lx Yu
 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.rst

@@ -1,17 +1,22 @@
-Pinyin Translator
-=================
+Pinyin
+======
 
 Translate chinese chars to pinyin based on Mandarin.dat
 
+Install
+-------
+
+.. code:: bash
+
+    $ pip install pinyin
+
 Usage
 -----
 
-Input unicode string
-
-::
+.. code:: python
 
     >>> import pinyin
-    >>> pinyin.get_pinyin(u'你好')
+    >>> pinyin.get(u'你好')
     'nihao'
     >>> pinyin.get_initial(u'你好')
     'n h'

pinyin/pinyin.py

@@ -1,4 +1,3 @@
-#!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
 __all__ = ['get_pinyin', 'get_initial']
@@ -14,7 +13,7 @@
         pinyin_dict[k] = v.lower().split(" ")[0][:-1]
 
 
-def pinyin_generator(chars):
+def _pinyin_generator(chars):
     """
     Generate pinyin for chars, if char is not chinese character,
     itself will be returned.
@@ -25,21 +24,21 @@ def pinyin_generator(chars):
         yield pinyin_dict.get(key, char)
 
 
-def get_pinyin(s):
-    """
-    Return pinyin of string, the input string must be unicode
+def get(s):
+    """Return pinyin of string, the string must be unicode
     """
-    assert(type(s) is unicode)
+    assert(isinstance(s, unicode))
+    return ''.join(_pinyin_generator(s))
 
-    generator = pinyin_generator(s)
-    return ''.join(generator)
+
+def get_pinyin(s):
+    """This function is only for backward compatibility, use `get` instead.
+    """
+    return get(s)
 
 
 def get_initial(s):
+    """Return the 1st char of pinyin of string, the string must be unicode
     """
-    Return the 1st char of pinyin of string, the input string must be unicode
-    """
-    assert(type(s) is unicode)
-
-    generator = pinyin_generator(s)
-    return ' '.join([p[0] for p in generator])
+    assert(isinstance(s, unicode))
+    return ' '.join([p[0] for p in _pinyin_generator(s)])