Merge branch 'dev' of github.com:mapswipe/python-mapswipe-workers into dev

Author: Matthias-Schaub

mapswipe_workers/LICENSE LICENSEmapswipe_workers/LICENSE renamed to LICENSE

@@ -64,3 +64,15 @@ Options:
                      remove credentials.
   --help             Show this message and exit.
 ```
+
+
+## Create Tutorial from json file (e.g. provided in sample data)
+
+```
+Usage: mapswipe_workers create-tutorial [OPTIONS]
+
+Options:
+  --input_file TEXT  The json file with your tutorial information.  [required]
+  --help             Show this message and exit.
+
+```

docs/source/cli.md

@@ -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

@@ -14,26 +14,27 @@ Welcome to MapSwipe Back-End's documentation!
    readme_link
    overview
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Using:
+
+   for_mapswipe_managers
+   cli
+
 
 .. toctree::
    :maxdepth: 2
    :caption: Deployment:
 
    configuration
    installation
+   tutorials
    updating
+   testing
    debugging
    backup
 
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Using:
-
-   for_mapswipe_managers
-   cli
-
-
 .. toctree::
    :maxdepth: 2
    :caption: Project Types and Data Model:

docs/source/index.rst

@@ -24,27 +24,17 @@ To run all tests you can simply run `bash test_00_main.sh`. There are still some
 * get firebase projects, groups and results before mapping and save to disk
 * for each user and project set random results for X groups in firebase through REST api, authenticated as normal user
 * get firebase projects, groups and results after mapping and save to disk
-
-**TODO**:
-* compare firebase before and after data, there are already some functions in `test_mock_results.py`
+* compare firebase before and after data
 
 ## Test Firebase to Postgres
 * `test_03_firebase_to_postgres.py`
 * copy new users from firebase to postgres
 * copy all results from firebase to postgres
 
-**TODO**:
-* how can we make sure that we only update users created during testing?
-* how can we make sure that we only transfer results for projects created during testing
-
 ## Generate Stats
 * `test_04_generate_stats.py`
 * generate csv files for all projects and users for which we got results since a timestamp defined in `last_update.txt`
 
-**TODO**:
-* check logic: what happens if `last_update.txt` is not there, but `--only_new_results` flag is set? --> stats for all projects and users should be created
-* how can we make sure that we only generate stats for projects and users created during testing
-
 ## Other
 * we don't have broader checks of firebase database rules
 * some database rules are checked indirectly, e.g. firebase read, write rules through REST api get, set requests during `test_02_mapping.py`

mapswipe_workers/tests/readme.md docs/source/testing.mdmapswipe_workers/tests/readme.md renamed to docs/source/testing.md

@@ -1,6 +1,18 @@
 # 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.
 
+## Deploy tutorials to Firebase Database from Docker
+You can upload tutorial data to Firebase like this:
+
+```bash
+docker run --name mapswipe_workers_local -it pythonmapswipeworkers_mapswipe_workers  bash`
+mapswipe_workers --verbose create-tutorial --input_file=sample_data/build_area_tutorial.json
+exit
+docker rm mapswipe_workers_local
+```
+
+If you want to use a customized tutorial make sure to adjust the `.json` file in the sample data folder and also add the file for the tasks.
+
 ## 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)
@@ -28,4 +40,4 @@ Tutorials will **not**:
 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, there could be two options: 1. `show more examples`, 2. `finish tutorial and start mapping`
+* once all tasks have been displayed you start to map for real projects

…wipe_workers/scripts/tutorials/readme.md docs/source/tutorials.mdmapswipe_workers/scripts/tutorials/readme.md renamed to docs/source/tutorials.md mapswipe_workers/scripts/tutorials/readme.md renamed to docs/source/tutorials.md

@@ -20,6 +20,8 @@ RUN mkdir -p /var/lib/mapswipe_workers/api-data/agg_res_by_user_id_and_date/
 # copy mapswipe workers repo from local repo
 WORKDIR /usr/local/mapswipe_workers/
 COPY mapswipe_workers/ mapswipe_workers/
+COPY sample_data/ sample_data/
+COPY tests/ tests/
 COPY requirements.txt .
 COPY setup.py .
 COPY config /usr/share/config/mapswipe_workers