added sub readmes

Author: vishwasmittal

Readme.md

@@ -44,6 +44,9 @@ issue the actions will result in some output and actions following it.
 
 ![Actions flow example](images/bot_action_flow.png)
 
+made using [draw.io](draw.io)
+
+
 #### Tech Stack:
 The bot is designed to work asynchronously.
 
@@ -57,4 +60,17 @@ code using that framework only.
 
 The complete architecture can be represented as:
 
-![Bot Architecture](images/bot_architecture.png)
+![Bot Architecture](images/bot_architecture.png)
+
+made using [draw.io](draw.io)
+
+**Storage Manager Base Class** shown in the diagram is the class that will
+manage the database interaction. It will provide methods for storing and
+retrieving data from database.
+
+
+### TODO
+
+- Add database methods for Async database interaction
+- Add Sub-modules in Interaction layer for reusing the architecture
+for multiple messenger services

actions_framework/readme.md

@@ -0,0 +1,19 @@
+# Actions
+
+Fundamental unit of User-Bot interaction (commands/data sent by user to
+the bot).
+
+There can be three `kinds` of such interactions:
+- `Command`: Slash commands that specify specific action eg `/start`.
+- `Message`: Fixed message that need not be represented as slash command.
+- `Input`: Request random keyboard input from the user.
+
+
+Each `Action` has following basic attributes:
+- `Trigger`: Keyword that can activate the command. (Doesn't contain
+preceding `/` in case of slash commands
+- `Kind`:
+    - `C`: for slash command
+    - `M`: for some fixed message
+    - `I`: for input action
+- `callback function`: function to be called when this action is invoked.

managers/Readme.md

@@ -0,0 +1,21 @@
+# Managers
+
+This module consists of manager classes that perform various functions.
+
+- **ActionManager**: Defined in [actions.py](actions.py). Responsible for
+managing and resolving actions for services.
+- **Interaction Manager**: Defined in [interaction.py](interaction.py).
+Responsible for the interaction and services via Interaction layer.
+
+    `ActionManager` can be considered a part of `InteractionManager`. Later
+    uses the former for resolution of actions and handles all other operations
+    by itself.
+
+- **BaseServiceManager**: Defined in [service_manager.py](service_manager.py).
+Base class for manager of a Bot service. Derive a new class from this class
+and override the `incoming_action_callback()` to define what to do when
+an action from this service was chosen. All the Children of this class, i.e.
+the managers of different services should be `Singleton Classes`.
+
+- **StorageManager**: Defined in [storage.py](storage.py). Class that defines
+methods for storing and retrieving data from database.

managers/actions.py

@@ -27,7 +27,7 @@ def register_service(self, name, callback):
     def service_register_message(self, *args, **kwargs):
         return "Choose from the options"
 
-    async def resolve_action(self, session, message):
+    def resolve_action(self, session, message):
         """
         This session will use the context in session['action'] to get the next publisher callback. For action, if there
         """

publish_framework/Readme.md

@@ -0,0 +1,12 @@
+# Publisher Framework
+The publisher framework that is responsible for Spamming the user with
+new content :stuck_out_tongue:.
+
+This module
+
+This Module, currently, consists of 4 parts.
+- **manager**: Manager for the Publisher Framework. A singleton class.
+- publishers: various publishers that will send the periodic data to the
+users
+- Filters
+- News Poller

publish_framework/filters/base.py

@@ -35,4 +35,5 @@ async def filter(self, content, to):
             :to: filtered list of recipients who can receive this content
         """
 
-        return True, content, to
+        # return True, content, to
+        raise NotImplementedError("filter() not implemented")