Merge pull request #75 from osmlab/dev

Merge dev > master

Author: mattmanley

CHANGELOG.md

@@ -4,25 +4,45 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v1.5.0](https://github.com/osmlab/maproulette-python-client/compare/v1.4.0...v1.5.0)
+
+> 3 September 2020
+
+- Merge dev > master [`#66`](https://github.com/osmlab/maproulette-python-client/pull/66)
+- Fix for challenge model mediumPriorityRule [`#65`](https://github.com/osmlab/maproulette-python-client/pull/65)
+- Adding endpoint for challenge keywords/tags [`#64`](https://github.com/osmlab/maproulette-python-client/pull/64)
+
+#### [v1.4.0](https://github.com/osmlab/maproulette-python-client/compare/v1.3.0...v1.4.0)
+
+> 19 August 2020
+
+- Merging dev -> master [`#62`](https://github.com/osmlab/maproulette-python-client/pull/62)
+- Adding batch functionality for posting new tasks [`#61`](https://github.com/osmlab/maproulette-python-client/pull/61)
+- Improve exceptions and fix JSON decoding bug [`#57`](https://github.com/osmlab/maproulette-python-client/pull/57)
+
+#### [v1.3.0](https://github.com/osmlab/maproulette-python-client/compare/v1.2.1...v1.3.0)
+
+> 15 July 2020
+
+- Dev -> master version fix [`#60`](https://github.com/osmlab/maproulette-python-client/pull/60)
+- Merging dev -> master [`#59`](https://github.com/osmlab/maproulette-python-client/pull/59)
+- Added keywords property to challenge model [`#53`](https://github.com/osmlab/maproulette-python-client/pull/53)
+- Fix challenge model and api bugs [`#51`](https://github.com/osmlab/maproulette-python-client/pull/51)
+
 #### [v1.2.1](https://github.com/osmlab/maproulette-python-client/compare/v1.2.0...v1.2.1)
 
 > 24 June 2020
 
 - Merging dev > master [`#49`](https://github.com/osmlab/maproulette-python-client/pull/49)
 - Add changelog [`#47`](https://github.com/osmlab/maproulette-python-client/pull/47)
 - Fixed challenge model issue [`#48`](https://github.com/osmlab/maproulette-python-client/pull/48)
-- add changelog [`a735e45`](https://github.com/osmlab/maproulette-python-client/commit/a735e45693dad6ea501ccfefbaced77d3fd3ab63)
-- Update __init__.py [`dbdf591`](https://github.com/osmlab/maproulette-python-client/commit/dbdf5911762f7de01dfe1c4bf350a835794e43bb)
 
 #### [v1.2.0](https://github.com/osmlab/maproulette-python-client/compare/v1.1.0...v1.2.0)
 
 > 24 June 2020
 
 - dev > master [`#46`](https://github.com/osmlab/maproulette-python-client/pull/46)
 - Add task and challenge endpoints [`#45`](https://github.com/osmlab/maproulette-python-client/pull/45)
-- Added new task and challenge methods [`1df0c9b`](https://github.com/osmlab/maproulette-python-client/commit/1df0c9bbcba4a801494938d9936f3bbb74fb675c)
-- Started adding task endpoints [`c3083a2`](https://github.com/osmlab/maproulette-python-client/commit/c3083a2adf766e5ef669fa8ec05e16a1598c603f)
-- Fixing formatting [`731e19c`](https://github.com/osmlab/maproulette-python-client/commit/731e19c2ff01acfc8379c01711cde36e5c31a8e5)
 
 #### [v1.1.0](https://github.com/osmlab/maproulette-python-client/compare/v1.0.0...v1.1.0)
 
@@ -33,9 +53,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Add travis & pypi badges [`#42`](https://github.com/osmlab/maproulette-python-client/pull/42)
 - Add new properties [`#38`](https://github.com/osmlab/maproulette-python-client/pull/38)
 - Added new user methods [`#40`](https://github.com/osmlab/maproulette-python-client/pull/40)
-- Added enums [`a65566a`](https://github.com/osmlab/maproulette-python-client/commit/a65566affac5a9a311fca4099870cc0d8bbebc5d)
-- Add more challenge properties [`280d70c`](https://github.com/osmlab/maproulette-python-client/commit/280d70cc5e081f32213a13132ee6a9e54954f485)
-- Change properties [`6660f05`](https://github.com/osmlab/maproulette-python-client/commit/6660f058ce6ab99a93bd2efd778d9c7f1a4287c2)
 
 #### v1.0.0
 
@@ -60,6 +77,3 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - [Travis] Set tox python version to 3.6 [`#5`](https://github.com/osmlab/maproulette-python-client/pull/5)
 - Add tox to requirements.txt & PR template [`#4`](https://github.com/osmlab/maproulette-python-client/pull/4)
 - Build initial scaffolding for project [`#1`](https://github.com/osmlab/maproulette-python-client/pull/1)
-- Initial commit with scaffolding [`9bd6cbb`](https://github.com/osmlab/maproulette-python-client/commit/9bd6cbb5a9cf277a841a2b1add8ddccd6af4aac4)
-- Create LICENSE [`90af651`](https://github.com/osmlab/maproulette-python-client/commit/90af651113f97537c20ab8b6996305d2c1cb0335)
-- Add new features to project api [`04488da`](https://github.com/osmlab/maproulette-python-client/commit/04488dab8ba396bc05aa265ee748d129caec64ad)

docs/index.rst

@@ -17,6 +17,9 @@ Welcome to MapRoulette's documentation!
    usage/models/project
    usage/models/challenge
    usage/models/task
+   usage/models/cooperative_work
+   usage/models/parent_operation
+   usage/models/child_operation
    usage/models/priority_rule
    usage/exceptions
 

docs/usage/models/child_operation.rst

@@ -0,0 +1,8 @@
+Child Operation Model
+=====================================================
+
+.. automodule:: maproulette.models.child_operation
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:

docs/usage/models/cooperative_work.rst

@@ -0,0 +1,8 @@
+Cooperative Work Model
+=====================================================
+
+.. automodule:: maproulette.models.cooperative_work
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:

docs/usage/models/enums.rst

@@ -0,0 +1,33 @@
+Enums
+=====================================================
+
+.. autoclass:: maproulette.models.enums.Conditions
+    :members:
+
+.. autoclass:: maproulette.models.enums.Types
+    :members:
+    :undoc-members:
+
+.. autoclass:: maproulette.models.enums.StringOperators
+    :members:
+    :undoc-members:
+
+.. autoclass:: maproulette.models.enums.NumericOperators
+    :members:
+    :undoc-members:
+
+.. autoclass:: maproulette.models.enums.OSMObjects
+    :members:
+    :undoc-members:
+
+.. autoclass:: maproulette.models.enums.OperationTypes
+    :members:
+    :undoc-members:
+
+.. autoclass:: maproulette.models.enums.Operations
+    :members:
+    :undoc-members:
+
+.. autoclass:: maproulette.models.enums.CooperativeWorkTypes
+    :members:
+    :undoc-members:

docs/usage/models/parent_operation.rst

@@ -0,0 +1,8 @@
+Parent Operation Model
+=====================================================
+
+.. automodule:: maproulette.models.parent_operation
+    :members:
+    :undoc-members:
+    :inherited-members:
+    :show-inheritance:

docs/usage/models/priority_rule.rst

@@ -6,22 +6,3 @@ Priority Rule Model
 
 .. autoclass:: maproulette.models.priority_rule.PriorityRuleModel
     :members:
-
-.. autoclass:: maproulette.models.priority_rule.Conditions
-    :members:
-
-.. autoclass:: maproulette.models.priority_rule.Types
-    :members:
-    :undoc-members:
-
-.. autoclass:: maproulette.models.priority_rule.Conditions
-    :members:
-    :undoc-members:
-
-.. autoclass:: maproulette.models.priority_rule.StringOperators
-    :members:
-    :undoc-members:
-
-.. autoclass:: maproulette.models.priority_rule.NumericOperators
-    :members:
-    :undoc-members:

examples/cooperative_work_examples.py

@@ -0,0 +1,74 @@
+import maproulette
+import json
+import base64
+
+# Create a configuration object for MapRoulette using your API key:
+config = maproulette.Configuration(api_key="API_KEY")
+
+# Create an API objects with the above config object:
+api = maproulette.Task(config)
+
+# Setting a challenge ID in which we'll place our cooperative task
+challenge_id = 14452
+
+# We'll start by creating some 'child' operations to apply to the target objects add them to a list:
+child_operations_list = [maproulette.ChildOperationModel(operation="setTags",
+                                                         data={"test_tag_1": "True",
+                                                               "test_tag_2": "True",
+                                                               "test_tag_3": "True"}).to_dict(),
+                         maproulette.ChildOperationModel(operation="setTags",
+                                                         data={"test_tag_4": "True"}).to_dict(),
+                         maproulette.ChildOperationModel(operation="setTags",
+                                                         data={"test_tag_5": "True"}).to_dict()]
+
+# Now we'll pass these operations into a 'parent' operation list to specify the objects to which the changes
+# will be applied:
+test_parent_relation = [maproulette.ParentOperationModel(operation_type="modifyElement",
+                                                         element_type="way",
+                                                         osm_id="175208404",
+                                                         child_operations=child_operations_list).to_dict()]
+
+# The below flags error when handling is in the constructor, but not when in the setter:
+test_2 = maproulette.ParentOperationModel(operation_type="modifyElement",
+                                element_type="way",
+                                osm_id="175208404",
+                                child_operations=child_operations_list)
+
+
+# Now that we have a Parent Operation containing the Child Operations we'd like to implement, we
+# can pass this into our Cooperative Work model:
+
+test_cooperative_work = maproulette.CooperativeWorkModel(version=2,
+                                                         type=1,
+                                                         parent_operations=test_parent_relation).to_dict()
+
+# Now we can create a basic task to apply these suggested changes to:
+with open('data/Example_Geometry.geojson', 'r') as data_file:
+    data = json.loads(data_file.read())
+
+test_task = maproulette.TaskModel(name="Test_Coop_Task_Kastellet",
+                                  parent=challenge_id,
+                                  geometries=data,
+                                  cooperative_work=test_cooperative_work).to_dict()
+
+
+# Finally, we'll pass our task object to into the create_task method to call the /task
+# endpoint, creating this new task with our cooperative work model applied
+print(json.dumps(api.create_task(test_task), indent=4, sort_keys=True))
+
+
+# Alternatively, cooperative work can be populated as in-progress edits via an OSM changefile (osc file)
+# as 'type 2' cooperative work:
+with open('data/ExampleChangefile.osc', 'rb') as data_file:
+    osc_file = base64.b64encode(data_file.read()).decode('ascii')
+
+test_osc_cooperative_work = maproulette.CooperativeWorkModel(type=2,
+                                                             content=osc_file).to_dict()
+
+test_osc_task = maproulette.TaskModel(name="Test_Coop_Task_Kastellet_OSC_2",
+                                  parent=challenge_id,
+                                  geometries=data,
+                                  cooperative_work=test_osc_cooperative_work).to_dict()
+
+print(json.dumps(api.create_task(test_osc_task), indent=4, sort_keys=True))
+

examples/data/ExampleChangefile.osc

@@ -0,0 +1,10 @@
+<osmChange version="0.6" generator="acme osm editor">
+    <create>
+        <node id="-1" changeset="-1" version="1" lat="55.69378277487475" lon="12.593096457148427" />
+        <node id="-2" changeset="-1" version="1" lat="55.689697320811575" lon="12.597881450158676" />
+        <way id="-3" changeset="-1" version="1">
+            <nd ref="-1"/>
+            <nd ref="-2"/>
+        </way>
+    </create>
+</osmChange>

maproulette/__init__.py

@@ -8,6 +8,9 @@
 from .models.challenge import ChallengeModel
 from .models.task import TaskModel
 from .models.priority_rule import PriorityRule, PriorityRuleModel
+from .models.child_operation import ChildOperationModel
+from .models.parent_operation import ParentOperationModel
+from .models.cooperative_work import CooperativeWorkModel
 from .models import priority_rule
 from .api.project import Project
 from .api.challenge import Challenge