Merge pull request #186 from mapswipe/dev

set up build area tutorial

Author: Hagellach37

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,6 +14,13 @@ Welcome to MapSwipe Back-End's documentation!
    readme_link
    overview
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Using:
+
+   for_mapswipe_managers
+   cli
+
 
 .. toctree::
    :maxdepth: 2
@@ -22,18 +29,11 @@ Welcome to MapSwipe Back-End's documentation!
    configuration
    installation
    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

@@ -28,4 +28,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