Merge pull request #1 from mattmanley/build_scaffolding

Build initial scaffolding for project

Author: Daniel B

.gitignore

@@ -0,0 +1,8 @@
+tox.ini
+venv
+.eggs
+.idea
+.tox
+*.pyc
+__pycache__
+maproulette.egg-info

.sonarcloud.properties

@@ -0,0 +1,9 @@
+language: python
+python:
+  - "3.6"
+# command to install dependencies
+install:
+  - pip install -r requirements.txt
+# command to run unit tests
+script:
+  - tox

.travis.yml

@@ -0,0 +1,17 @@
+import json
+import maproulette
+
+# Create a configuration object using an API key
+configuration = maproulette.Configuration(api_key='{YOUR_API_KEY}')
+
+# Create an API object using your config object
+api = maproulette.Api(configuration)
+
+# Initialize a project model using the project name
+my_project = maproulette.ProjectModel(name='my_new_project_name_20200120_abc')
+
+# You can set other parameters like your project description like this:
+my_project.description = 'my project description'
+
+# Print the API response
+print(json.dumps(api.create_project(my_project), indent=4, sort_keys=True))

examples/__init__.py

@@ -0,0 +1,14 @@
+import maproulette
+import json
+
+# Create a configuration object using a url and API key
+config = maproulette.Configuration(api_key='{YOUR_API_KEY}')
+
+# Create an API object using your config object
+api = maproulette.Api(config)
+
+# We want to fetch a project with name 'Health Facilities in India'
+my_project_name = 'Health Facilities in India'
+
+# Print the API response
+print(json.dumps(api.find_project(my_project_name), indent=4, sort_keys=True))

examples/create_project_from_model.py

@@ -0,0 +1,14 @@
+import maproulette
+import json
+
+# Create a configuration object using an API key
+config = maproulette.Configuration(api_key='{YOUR_API_KEY}')
+
+# Create an API object using your config object
+api = maproulette.Api(config)
+
+# We want to fetch a project with ID '4719'
+my_project_id = '4719'
+
+# Print the API response
+print(json.dumps(api.get_project_by_id(my_project_id), indent=4, sort_keys=True))

examples/find_project.py

@@ -0,0 +1,14 @@
+import maproulette
+import json
+
+# Create a configuration object using an API key
+config = maproulette.Configuration(api_key='YOUR_API_KEY')
+
+# Create an API object using your config object
+api = maproulette.Api(config)
+
+# We want to fetch a project with name 'Health Facilities in India'
+my_project_name = 'Health Facilities in India'
+
+# Print the API response
+print(json.dumps(api.get_project_by_name(my_project_name), indent=4, sort_keys=True))

examples/get_project_by_id.py

@@ -0,0 +1,14 @@
+import maproulette
+import json
+
+# Create a configuration object using a url and API key
+config = maproulette.Configuration(api_key='YOUR_API_KEY')
+
+# Create an API object using your config object
+api = maproulette.Api(config)
+
+# The ID of the project whose challenges I want to fetch is 4719
+my_project_id = '4719'
+
+# Print the API response
+print(json.dumps(api.get_project_challenges(my_project_id), indent=4, sort_keys=True))

examples/get_project_by_name.py

@@ -0,0 +1,14 @@
+import maproulette
+import json
+
+# Create a configuration object using an API key
+config = maproulette.Configuration(api_key='YOUR_API_KEY')
+
+# Create an API object using your config object
+api = maproulette.Api(config)
+
+# The ID of the project whose children I want to fetch is 4719
+my_project_id = '4719'
+
+# Print the API response
+print(json.dumps(api.get_project_children(my_project_id), indent=4, sort_keys=True))