Empty bot generator (#356)

* Initial template for echo bot

* Added template zip file

* Added template zip file

* Readme for top level generators folder

* Pylint fixes for generator, readme updates

* Adding empty bot generator, ported latest on_error changes

* PR changes addressed

Author: axelsrz

generators/README.md

@@ -37,8 +37,8 @@ The Core Bot template consists of set of core features most every bot is likely
 
 | Core Bot Features | Description |
 | ------------------ | ----------- |
-| [Send and receive messages](https://docs.microsoft.com/azure/bot-service/bot-builder-howto-send-messages?view=azure-bot-service-4.0&tabs=javascript) | The primary way your bot will communicate with users, and likewise receive communication, is through message activities. Some messages may simply consist of plain text, while others may contain richer content such as cards or attachments. |
-| [Proactive messaging](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-howto-proactive-message?view=azure-bot-service-4.0) using [Adaptive Cards](https://docs.microsoft.com/azure/bot-service/bot-builder-send-welcome-message?view=azure-bot-service-4.0?#using-adaptive-card-greeting) | The primary goal when creating any bot is to engage your user in a meaningful conversation. One of the best ways to achieve this goal is to ensure that from the moment a user first connects to your bot, they understand your bot’s main purpose and capabilities.  We refer to this as "welcoming the user."  The Core template uses an [Adaptive Card](http://adaptivecards.io) to implement this behavior.  |
+| [Send and receive messages](https://docs.microsoft.com/azure/bot-service/bot-builder-howto-send-messages?view=azure-bot-service-4.0) | The primary way your bot will communicate with users, and likewise receive communication, is through message activities. Some messages may simply consist of plain text, while others may contain richer content such as cards or attachments. |
+| [Proactive messaging](https://docs.microsoft.com/azure/bot-service/bot-builder-howto-proactive-message?view=azure-bot-service-4.0) using [Adaptive Cards](https://docs.microsoft.com/azure/bot-service/bot-builder-send-welcome-message?view=azure-bot-service-4.0?#using-adaptive-card-greeting) | The primary goal when creating any bot is to engage your user in a meaningful conversation. One of the best ways to achieve this goal is to ensure that from the moment a user first connects to your bot, they understand your bot’s main purpose and capabilities.  We refer to this as "welcoming the user."  The Core template uses an [Adaptive Card](http://adaptivecards.io) to implement this behavior.  |
 | [Language understanding using LUIS](https://docs.microsoft.com/azure/bot-service/bot-builder-howto-v4-luis?view=azure-bot-service-4.0) | The ability to understand what your user means conversationally and contextually can be a difficult task, but can provide your bot a more natural conversation feel. Language Understanding, called LUIS, enables you to do just that so that your bot can recognize the intent of user messages, allow for more natural language from your user, and better direct the conversation flow. |
 | [Multi-turn conversation support using Dialogs](https://docs.microsoft.com/azure/bot-service/bot-builder-concept-dialog?view=azure-bot-service-4.0) | The ability to manage conversations is an important part of the bot/user interation.  Bot Framework introduces the  concept of a Dialog to handle this conversational pattern.  Dialog objects process inbound Activities and generate outbound responses. The business logic of the bot runs either directly or indirectly within Dialog classes.  |
 | [Managing conversation state](https://docs.microsoft.com/azure/bot-service/bot-builder-howto-v4-state?view=azure-bot-service-4.0) | A key to good bot design is to track the context of a conversation, so that your bot remembers things like the answers to previous questions. |
@@ -51,7 +51,7 @@ The Empty Bot template is the minimal skeleton code for a bot.  It provides a st
 
 ## Features by Template
 
-|  Feature  |  Empty Bot*  |  Echo Bot   |  Core Bot*  |
+|  Feature  |  Empty Bot  |  Echo Bot   |  Core Bot*  |
 | --------- | :-----: | :-----: | :-----: |
 | Generate code in Python | X | X | X |
 | Support local development and testing using the [Bot Framework Emulator v4](https://www.github.com/microsoft/botframework-emulator) | X | X | X |
@@ -64,7 +64,7 @@ The Empty Bot template is the minimal skeleton code for a bot.  It provides a st
 | Handle user interruptions |  |  | X |
 | Unit test a bot using Bot Framework Testing framework (optional) |  |  | X |
 
-*Empty Bot and Core Bot templates are work in progress landing soon. 
+*Core Bot template is a work in progress landing soon. 
 ## Installation
 
 1. Install [cookiecutter](https://github.com/cookiecutter/cookiecutter) using [pip](https://pip.pypa.io/en/stable/) (we assume you have pre-installed [python 3](https://www.python.org/downloads/)).
@@ -99,7 +99,7 @@ To create a Core Bot project:
 To create an Empty Bot project:
 
 ```bash
-# Work in progress
+cookiecutter https://github.com/microsoft/botbuilder-python/releases/download/Templates/empty.zip
 ```
 
 When the generator is launched, it will prompt for the information required to create a new bot.

generators/app/templates/echo/{{cookiecutter.bot_name}}/README.md

@@ -8,7 +8,7 @@ This bot has been created using [Bot Framework](https://dev.botframework.com), i
 
 This sample **requires** prerequisites in order to run.
 
-### Install Python 3.7
+### Install Python 3.6
 
 ## Running the sample
 - Run `pip install -r requirements.txt` to install all dependencies
@@ -37,7 +37,6 @@ This sample **requires** prerequisites in order to run.
 - [Activity processing](https://docs.microsoft.com/en-us/azure/bot-service/bot-builder-concept-activity-processing?view=azure-bot-service-4.0)
 - [Azure Bot Service Introduction](https://docs.microsoft.com/azure/bot-service/bot-service-overview-introduction?view=azure-bot-service-4.0)
 - [Azure Bot Service Documentation](https://docs.microsoft.com/azure/bot-service/?view=azure-bot-service-4.0)
-- [.NET Core CLI tools](https://docs.microsoft.com/dotnet/core/tools/?tabs=netcore2x)
 - [Azure CLI](https://docs.microsoft.com/cli/azure/?view=azure-cli-latest)
 - [Azure Portal](https://portal.azure.com)
 - [Language Understanding using LUIS](https://docs.microsoft.com/azure/cognitive-services/luis/)

generators/app/templates/echo/{{cookiecutter.bot_name}}/app.py

@@ -3,16 +3,16 @@
 
 import asyncio
 import sys
+from datetime import datetime
 from types import MethodType
 
 from flask import Flask, request, Response
 from botbuilder.core import (
     BotFrameworkAdapter,
     BotFrameworkAdapterSettings,
-    MessageFactory,
     TurnContext,
 )
-from botbuilder.schema import Activity, InputHints
+from botbuilder.schema import Activity, ActivityTypes
 from bot import MyBot
 
 # Create the loop and Flask app
@@ -30,20 +30,24 @@ async def on_error(self, context: TurnContext, error: Exception):
     # This check writes out errors to console log .vs. app insights.
     # NOTE: In production environment, you should consider logging this to Azure
     #       application insights.
-    print(f"\n [on_turn_error]: {error}", file=sys.stderr)
+    print(f"\n [on_turn_error] unhandled error: {error}", file=sys.stderr)
 
     # Send a message to the user
-    error_message_text = "Sorry, it looks like something went wrong."
-    error_message = MessageFactory.text(
-        error_message_text, error_message_text, InputHints.expecting_input
-    )
-    await context.send_activity(error_message)
-
-    # pylint: disable=protected-access
-    if self._conversation_state:
-        # If state was defined, cleare it.
-        await self._conversation_state.delete(context)
-
+    await context.send_activity("The bot encounted an error or bug.")
+    await context.send_activity("To continue to run this bot, please fix the bot source code.")
+    # Send a trace activity if we're talking to the Bot Framework Emulator
+    if context.activity.channel_id == 'emulator':
+        # Create a trace activity that contains the error object
+        trace_activity = Activity(
+            label="TurnError",
+            name="on_turn_error Trace",
+            timestamp=datetime.utcnow(),
+            type=ActivityTypes.trace,
+            value=f"{error}",
+            value_type="https://www.botframework.com/schemas/error"
+        )
+        # Send a trace activity, which will be displayed in Bot Framework Emulator
+        await context.send_activity(trace_activity)
 
 ADAPTER.on_turn_error = MethodType(on_error, ADAPTER)
 
@@ -64,12 +68,9 @@ def messages():
         request.headers["Authorization"] if "Authorization" in request.headers else ""
     )
 
-    async def aux_func(turn_context):
-        await BOT.on_turn(turn_context)
-
     try:
         task = LOOP.create_task(
-            ADAPTER.process_activity(activity, auth_header, aux_func)
+            ADAPTER.process_activity(activity, auth_header, BOT.on_turn)
         )
         LOOP.run_until_complete(task)
         return Response(status=201)

generators/app/templates/echo/{{cookiecutter.bot_name}}/config.py

@@ -10,7 +10,3 @@ class DefaultConfig:
     PORT = 3978
     APP_ID = os.environ.get("MicrosoftAppId", "")
     APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "")
-    LUIS_APP_ID = os.environ.get("LuisAppId", "")
-    LUIS_API_KEY = os.environ.get("LuisAPIKey", "")
-    # LUIS endpoint host name, ie "westus.api.cognitive.microsoft.com"
-    LUIS_API_HOST_NAME = os.environ.get("LuisAPIHostName", "")

generators/app/templates/empty/cookiecutter.json

@@ -0,0 +1,4 @@
+{
+    "bot_name": "my_chat_bot",
+    "bot_description": "Demonstrate the core capabilities of the Microsoft Bot Framework"
+}