work on tutorials

Author: Hagellach37

mapswipe_workers/LICENSE LICENSEmapswipe_workers/LICENSE renamed to LICENSE

@@ -41,4 +41,4 @@ docker run --name mapswipe_workers_local -it pythonmapswipeworkers_mapswipe_work
 mapswipe_workers --verbose user-management [email protected] --manager=true
 exit
 docker rm mapswipe_workers_local
-
+```

docs/source/for_mapswipe_managers.md

@@ -0,0 +1,31 @@
+# Tutorials
+For each project type there should be at least one tutorial. Tutorials are similar to actual projects. To display the tutorial we will use the same design and screens as if a user would map for real.
+
+## Data Perspective
+Tutorials and projects have the following in common:
+* both have groups with the same structure (there can also be several groups per tutorial)
+* both have tasks
+
+However, for tutorials there are some additional attributes for tasks:
+* `referenceAnswer`: this is the expected answer
+* `category`: this refers to what the user should learn in this task (e.g. to map a building or correctly classify clouds)
+
+What are *categories*?
+* for each project type we can think about several steps that the users should learn (e.g. learn how to map a building, learn what is not a building, ...)
+* for each project type there is a fixed number of categories
+* for each category there will be 3 text caption:
+    * `pre`: will be displayed initially
+    * `post_correct`: will be displayed if expected result(s) and actual result(s) match
+    * `post_wrong`: will be displayed if expected result(s) and actual result(s) **don't** match
+* the text captions for the categories should be translated to all available languages 
+   
+## Functionality Perspective
+The main interaction will be the same for projects and tutorials. However, there will be sligh differences:
+
+Tutorials will **not**:
+* upload results to firebase (and increase your user statistics)
+
+Tutorials will:
+* show the expected results after your first swipe or interaction
+* show the next tasks after swiping again (after the expected results have been shown)
+* once all tasks have been displayed you start to map for real projects

docs/source/tutorials.md

@@ -2,6 +2,7 @@
 import click
 import schedule as sched
 import pickle
+import json
 
 from mapswipe_workers.definitions import CustomError
 from mapswipe_workers.definitions import logger
@@ -14,6 +15,7 @@
 from mapswipe_workers.firebase_to_postgres import update_data
 from mapswipe_workers.project_types.build_area.build_area_project \
         import BuildAreaProject
+from mapswipe_workers.project_types.build_area import build_area_tutorial
 from mapswipe_workers.project_types.footprint.footprint_project \
         import FootprintProject
 from mapswipe_workers.project_types.change_detection.change_detection_project \
@@ -207,6 +209,36 @@ def run_user_management(email, manager):
         logger.exception(e)
 
 
+@click.command('create-tutorial')
+@click.option(
+        '--input_file',
+        help=(
+            f'The json file with your tutorial information.'
+            ),
+        required=True,
+        type=str
+        )
+def run_create_tutorial(input_file):
+    sentry.init_sentry()
+    try:
+        logger.info(f'will generate tutorial based on {input_file}')
+        with open(input_file) as json_file:
+            tutorial = json.load(json_file)
+
+        project_type = tutorial['projectType']
+
+        project_types_tutorial = {
+            # Make sure to import all project types here
+            1: build_area_tutorial.create_tutorial
+        }
+
+        project_types_tutorial[project_type](tutorial)
+    except Exception as e:
+        slack.send_error(e)
+        sentry.capture_exception_sentry(e)
+        logger.exception(e)
+
+
 @click.command('run')
 @click.option(
         '--schedule',
@@ -372,4 +404,5 @@ def _run_user_management(email, manager):
 cli.add_command(run_firebase_to_postgres)
 cli.add_command(run_generate_stats)
 cli.add_command(run_user_management)
+cli.add_command(run_create_tutorial)
 cli.add_command(run)