Merge pull request #13 from carpedm20/v0.3-maint

Cleanup and version bump for #11.
carpedm20 · May 19, 2015 · e97cef2 · e97cef2
2 parents db53363 + e57288e
commit e97cef2
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 15 deletions.
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -1,6 +1,14 @@
 emoji
 =====
 
+0.3.4
+-----
+
+* Restored default functionality - #6
+* Removed `emoji.decode()` - #10
+* Added `use_aliases` to `emoji.emojize()` to enable the GitHub aliases and others - #8
+
+
 0.2
 ---
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,7 @@
 include LICENSE.txt
 include MANIFEST.in
 include README.rst
+include CHANGES.txt
 include requirements.txt
 include setup.cfg
 include setup.py

diff --git a/README.rst b/README.rst
@@ -1,26 +1,28 @@
-=====
 Emoji
 =====
 
-`Emoji <http://www.unicode.org/Public/emoji/1.0/full-emoji-list.html>`__  for Python.  This project was inspired by `kyokomi <https://github.com/kyokomi/emoji>`__.
+Emoji for Python.  This project was inspired by `kyokomi <https://github.com/kyokomi/emoji>`__.
 
 
 Example
-=======
+-------
+
+The entire set of Emoji codes as defined by the `unicode consortium <http://www.unicode.org/Public/emoji/1.0/full-emoji-list.html>`__
+is supported in addition to a bunch of `aliases <http://www.emoji-cheat-sheet.com/>`__.  By
+default only the official list is enabled but doing ``emoji.emojize(use_aliases=True)`` enables
+both the full list and aliases.
 
 .. code-block:: python
 
     >> import emoji
-    >> print(emoji.emojize('Python is :thumbsup:'))
+    >> print(emoji.emojize('Python is :thumbs_up_sign:'))
     Python is 👍
-    >> print(emoji.emojize('Python is :thumbs_up_sign:', use_aliases=False))
+    >> print(emoji.emojize('Python is :thumbsup:', use_aliases=True))
     Python is 👍
-    >> print(emoji.decode('👍'))
-    :+1:
 
 
 Installation
-============
+------------
 
 Via pip:
 
@@ -38,13 +40,15 @@ From master branch:
 
 
 Link
-====
+----
 
 `Emoji Cheat Sheet <http://www.emoji-cheat-sheet.com/>`__
 
+`Official unicode list <http://www.unicode.org/Public/emoji/1.0/full-emoji-list.html>`__
+
 
 Authors
-=======
+-------
 
 Taehoon Kim / `@carpedm20 <http://carpedm20.github.io/about/>`__
 

diff --git a/emoji/__init__.py b/emoji/__init__.py
@@ -1,26 +1,25 @@
 # -*- coding: UTF-8 -*-
 
+
 """
 emoji for Python
 ~~~~~~~~~~~~~~~~
 
 emoji terminal output for Python.
 
     >>> import emoji
-    >>> print(emoji.emojize('Python is :thumbsup:'))
+    >>> print(emoji.emojize('Python is :thumbsup:', use_aliases=True))
     Python is 👍
-    >> print(emoji.emojize('Python is :thumbs_up_sign:', is_alias=False))
+    >> print(emoji.emojize('Python is :thumbs_up_sign:'))
     Python is 👍
-    >>> print(emoji.decode('👍'))
-    :+1:
 """
 
 
 from .core import *
 from .unicode_codes import *
 
 
-__version__ = '0.3.3'
+__version__ = '0.3.4'
 __author__ = 'Taehoon Kim and Kevin Wurster'
 __email__ = 'carpedm20@gmail.com and wursterk@gmail.com'
 __source__ = 'https://github.com/carpedm20/emoji/'