Rename package and modify related code. Rewrite README.md. Fix simple-server-echo (for python2 and 3 issue)

Author: be-hase

MANIFEST.in

@@ -1,3 +1,5 @@
 include LICENSE
 include requirements.txt
-include requirements-test.txt
+include requirements-test.txt
+include requirements-dev.txt
+include tox.ini

README.md

@@ -13,7 +13,7 @@ ja: https://devdocs.line.me/ja/
 ## Install
 
 ```
-$ pip install line_bot
+$ pip install line-bot-sdk
 ```
 
 ## Synopsis
@@ -23,9 +23,14 @@ Usage is:
 ```python
 from flask import Flask, request, abort
 
-from line_bot import (
-    LineBotApi, MessageEvent, TextMessage, TextSendMessage,
-    WebhookParser, InvalidSignatureError
+from linebot import (
+    LineBotApi, WebhookHandler
+)
+from linebot.exceptions import (
+    InvalidSignatureError
+)
+from linebot.models import (
+    MessageEvent, TextMessage, TextSendMessage,
 )
 
 app = Flask(__name__)
@@ -70,7 +75,7 @@ def handle_message(event):
 Create a new LineBotApi instance.
 
 ```python
-line_bot_api = LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
+line_bot_api = linebot.LineBotApi('YOUR_CHANNEL_ACCESS_TOKEN')
 ```
 
 You can override `timeout` value at each methods.
@@ -160,16 +165,16 @@ try:
         'to',
         TextSendMessage(text='Hello World!')
     )
-except LineBotApiError as e:
+except linebot.LineBotApiError as e:
     print(e.error.message)
     print(e.error.details)
 ```
 
 ### Send message object
 
-How to create Send message object
+https://devdocs.line.me/en/#send-message-object
 
-(See also https://devdocs.line.me/en/#send-message-object)
+These following class in `linebot.models` package.
 
 #### TextSendMessage
 
@@ -360,7 +365,7 @@ carousel_template_message = TemplateSendMessage(
 #### \__init__(self, channel_secret)
 
 ```python
-parser = WebhookParser('YOUR_CHANNEL_SECRET')
+parser = linebot.WebhookParser('YOUR_CHANNEL_SECRET')
 ```
 
 #### parse(self, body, signature)
@@ -382,7 +387,7 @@ for event in events:
 #### \__init__(self, channel_secret)
 
 ```python
-handler = WebhookHandler('YOUR_CHANNEL_SECRET')
+handler = linebot.WebhookHandler('YOUR_CHANNEL_SECRET')
 ```
 
 #### handle(self, body, signature)
@@ -431,6 +436,8 @@ There is no handler for event, this default handler method is called.
 
 https://devdocs.line.me/en/#webhooks
 
+These following class in `linebot.models` package.
+
 #### Event
 
 * MessageEvent

examples/flask-echo/README.md

@@ -4,16 +4,21 @@ Sample echo-bot using [Flask](http://flask.pocoo.org/)
 
 ## Getting Start
 
-WebhookParser sample
-
 ```
+$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET
+$ export LINE_CHANNEL_ACCESS_TOKEN=YOUR_LINE_CHANNEL_ACCESS_TOKEN
+
 $ pip install -r requirements.txt
+```
+
+Run WebhookParser sample
+
+```
 $ python app.py
 ```
 
-WebhookHandler sample
+Run WebhookHandler sample
 
 ```
-$ pip install -r requirements.txt
 $ python app_with_handler.py
 ```

examples/flask-echo/app.py

@@ -1,27 +1,33 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
 import os
+import sys
 from argparse import ArgumentParser
 
 from flask import Flask, request, abort
 
-from line_bot import (
+from linebot import (
     LineBotApi, WebhookParser
 )
-from line_bot.exceptions import (
+from linebot.exceptions import (
     InvalidSignatureError
 )
-from line_bot.models import (
+from linebot.models import (
     MessageEvent, TextMessage, TextSendMessage,
 )
 
 app = Flask(__name__)
 
 # get channel_secret and channel_access_token from your environment variable
 channel_secret = os.getenv('LINE_CHANNEL_SECRET', None)
-if channel_secret is None:
-    print('Specify LINE_CHANNEL_SECRET as env.')
 channel_access_token = os.getenv('LINE_CHANNEL_ACCESS_TOKEN', None)
+if channel_secret is None:
+    print('Specify LINE_CHANNEL_SECRET as environment variable.')
+    sys.exit(1)
 if channel_access_token is None:
-    print('Specify LINE_CHANNEL_ACCESS_TOKEN as env.')
+    print('Specify LINE_CHANNEL_ACCESS_TOKEN as environment variable.')
+    sys.exit(1)
 
 line_bot_api = LineBotApi(channel_access_token)
 parser = WebhookParser(channel_secret)

examples/flask-echo/app_with_handler.py

@@ -1,27 +1,30 @@
 import os
+import sys
 from argparse import ArgumentParser
 
 from flask import Flask, request, abort
 
-from line_bot import (
+from linebot import (
     LineBotApi, WebhookHandler
 )
-from line_bot.exceptions import (
+from linebot.exceptions import (
     InvalidSignatureError
 )
-from line_bot.models import (
+from linebot.models import (
     MessageEvent, TextMessage, TextSendMessage,
 )
 
 app = Flask(__name__)
 
 # get channel_secret and channel_access_token from your environment variable
 channel_secret = os.getenv('LINE_CHANNEL_SECRET', None)
-if channel_secret is None:
-    print('Specify LINE_CHANNEL_SECRET as env.')
 channel_access_token = os.getenv('LINE_CHANNEL_ACCESS_TOKEN', None)
+if channel_secret is None:
+    print('Specify LINE_CHANNEL_SECRET as environment variable.')
+    sys.exit(1)
 if channel_access_token is None:
-    print('Specify LINE_CHANNEL_ACCESS_TOKEN as env.')
+    print('Specify LINE_CHANNEL_ACCESS_TOKEN as environment variable.')
+    sys.exit(1)
 
 line_bot_api = LineBotApi(channel_access_token)
 handler = WebhookHandler(channel_secret)

examples/flask-echo/requirements.txt

@@ -1,2 +1,2 @@
-line_bot
+line-bot-sdk
 flask

examples/flask-kitchensink/README.md

@@ -5,6 +5,10 @@ Sample bot using [Flask](http://flask.pocoo.org/)
 ## Getting Start
 
 ```
+$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET
+$ export LINE_CHANNEL_ACCESS_TOKEN=YOUR_LINE_CHANNEL_ACCESS_TOKEN
+
 $ pip install -r requirements.txt
+
 $ python app.py
 ```

examples/flask-kitchensink/app.py

@@ -3,17 +3,18 @@
 
 import errno
 import os
+import sys
 from argparse import ArgumentParser
 
 from flask import Flask, request, abort
 
-from line_bot import (
+from linebot import (
     LineBotApi, WebhookHandler
 )
-from line_bot.exceptions import (
+from linebot.exceptions import (
     InvalidSignatureError
 )
-from line_bot.models import (
+from linebot.models import (
     MessageEvent, TextMessage, TextSendMessage,
     SourceUser, SourceGroup, SourceRoom,
     TemplateSendMessage, ConfirmTemplate, MessageTemplateAction,
@@ -28,11 +29,13 @@
 
 # get channel_secret and channel_access_token from your environment variable
 channel_secret = os.getenv('LINE_CHANNEL_SECRET', None)
-if channel_secret is None:
-    print('Specify LINE_CHANNEL_SECRET as env.')
 channel_access_token = os.getenv('LINE_CHANNEL_ACCESS_TOKEN', None)
+if channel_secret is None:
+    print('Specify LINE_CHANNEL_SECRET as environment variable.')
+    sys.exit(1)
 if channel_access_token is None:
-    print('Specify LINE_CHANNEL_ACCESS_TOKEN as env.')
+    print('Specify LINE_CHANNEL_ACCESS_TOKEN as environment variable.')
+    sys.exit(1)
 
 line_bot_api = LineBotApi(channel_access_token)
 handler = WebhookHandler(channel_secret)

examples/flask-kitchensink/requirements.txt

@@ -1,2 +1,2 @@
-line_bot
+line-bot-sdk
 flask

examples/simple-server-echo/README.md

@@ -5,7 +5,11 @@ Sample echo-bot using [wsgiref.simple_server](https://docs.python.org/3/library/
 ## Getting Start
 
 ```
+$ export LINE_CHANNEL_SECRET=YOUR_LINE_CHANNEL_SECRET
+$ export LINE_CHANNEL_ACCESS_TOKEN=YOUR_LINE_CHANNEL_ACCESS_TOKEN
+
 $ pip install -r requirements.txt
+
 $ python app.py
 ```
 

examples/simple-server-echo/app.py

@@ -1,26 +1,31 @@
 # -*- coding: utf-8 -*-
-
 import os
+import sys
 import wsgiref.simple_server
 from argparse import ArgumentParser
 
-from line_bot import (
+from builtins import bytes
+
+from linebot import (
     LineBotApi, WebhookParser
 )
-from line_bot.exceptions import (
+from linebot.exceptions import (
     InvalidSignatureError
 )
-from line_bot.models import (
+from linebot.models import (
     MessageEvent, TextMessage, TextSendMessage
 )
+from linebot.utils import PY3
 
-# get from os env
+# get channel_secret and channel_access_token from your environment variable
 channel_secret = os.getenv('LINE_CHANNEL_SECRET', None)
-if channel_secret is None:
-    print('Specify LINE_CHANNEL_SECRET as env.')
 channel_access_token = os.getenv('LINE_CHANNEL_ACCESS_TOKEN', None)
+if channel_secret is None:
+    print('Specify LINE_CHANNEL_SECRET as environment variable.')
+    sys.exit(1)
 if channel_access_token is None:
-    print('Specify LINE_CHANNEL_ACCESS_TOKEN as env.')
+    print('Specify LINE_CHANNEL_ACCESS_TOKEN as environment variable.')
+    sys.exit(1)
 
 line_bot_api = LineBotApi(channel_access_token)
 parser = WebhookParser(channel_secret)
@@ -30,12 +35,12 @@ def application(environ, start_response):
     # check request path
     if environ['PATH_INFO'] != '/callback':
         start_response('404 Not Found', [])
-        return 'Not Found'
+        return create_body('Not Found')
 
     # check request method
     if environ['REQUEST_METHOD'] != 'POST':
         start_response('405 Method Not Allowed', [])
-        return 'Method Not Allowed'
+        return create_body('Method Not Allowed')
 
     # get X-Line-Signature header value
     signature = environ['HTTP_X_LINE_SIGNATURE']
@@ -50,7 +55,7 @@ def application(environ, start_response):
         events = parser.parse(body, signature)
     except InvalidSignatureError:
         start_response('400 Bad Request', [])
-        return 'Bad Request'
+        return create_body('Bad Request')
 
     # if event is MessageEvent and message is TextMessage, then echo text
     for event in events:
@@ -65,7 +70,14 @@ def application(environ, start_response):
         )
 
     start_response('200 OK', [])
-    return 'OK'
+    return create_body('OK')
+
+
+def create_body(text):
+    if PY3:
+        return [bytes(text, 'utf-8')]
+    else:
+        return text
 
 
 if __name__ == '__main__':

examples/simple-server-echo/requirements.txt

@@ -1 +1 @@
-line_bot
+line-bot-sdk

line_bot/__about__.py linebot/__about__.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 from __future__ import unicode_literals
 
-__version__ = '0.0.1'
+__version__ = '0.1.0'
 
 __all__ = (
     '__version__'

line_bot/__init__.py linebot/__init__.py

@@ -5,7 +5,7 @@
 import re
 import sys
 
-LOGGER = logging.getLogger('line_bot')
+LOGGER = logging.getLogger('linebot')
 
 PY3 = sys.version_info[0] == 3