Merge pull request #144 from mapillary/Rubix982/ModificationFor__get_image_looking_at

Modification For `get_image_looking_at`

Author: Rubix982

.github/workflows/documentation.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '12.x'
+          node-version: '14.x'
       - name: Test Build
         run: |
           cd docs
@@ -33,7 +33,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
         with:
-          node-version: '12.x'
+          node-version: '14.x'
       - uses: webfactory/[email protected]
         with:
           ssh-private-key: ${{ secrets.GH_PAGES_DEPLOY }}

.github/workflows/pytest.yml

@@ -22,9 +22,11 @@ jobs:
         python-version: 3.9
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip
-        pip install flake8 black pytest requests mercantile vt2geojson mapillary pandas
+        python -m pip install --upgrade pip && make setup-dev && pip install flake8 black pytest requests mercantile vt2geojson pandas
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Locally install branch's mapillary
+      run: |
+        make build && pip3 install -e .
     - name: Formatting with black
       run: |
         make format
@@ -33,4 +35,4 @@ jobs:
         make lint
     - name: Test with pytest
       run: |
-        make test
+          make test

.vscode/settings.json

@@ -1,3 +1,5 @@
 {
-    "python.formatting.provider": "black"
+    "python.formatting.provider": "black",
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
 }

Pipfile

@@ -43,7 +43,6 @@ python-dotenv = "==0.19.0"
 shapely = "==1.8.1"
 turfpy = "==0.0.7"
 geojson = "==2.5.0"
-pip = "==21.2.4"
 
 [dev-packages]
 wheel = "==0.37.0"
@@ -70,7 +69,7 @@ regex = "==2021.4.4"
 toml = "==0.10.2"
 twine = "==1.13.0"
 check-manifest = "==0.46"
-sphinx = "==4.1.2"
+sphinx = "==5.1.1"
 sphinx-markdown-builder = "==0.5.4"
 sphinx-autodoc-typehints = "==1.12.0"
 python-dateutil = "*"

Pipfile.lock

@@ -3,7 +3,7 @@ sidebar position: 1
 ---
 
 <!-- src documentation master file, created by
-sphinx-quickstart on Fri Sep 17 21:39:39 2021.
+sphinx-quickstart on Mon Aug  8 18:09:39 2022.
 You can adapt this file completely to your liking, but it should at least
 contain the root `toctree` directive. -->
 # Welcome to the Mapillary’s Python SDK documentation!

docs/docs/Table Of Contents.md

@@ -17,7 +17,7 @@ For more information, please check out [https://www.mapillary.com/developer/api-
 * License: MIT LICENSE
 
 
-### mapillary.controller.detection.get_image_detections_controller(image_id: Union[str, int], fields: Optional[list] = None)
+### mapillary.controller.detection.get_image_detections_controller(image_id: Union[str, int], fields: list = [])
 Get image detections with given (image) key
 
 
@@ -44,7 +44,7 @@ Get image detections with given (image) key
 
 
 
-### mapillary.controller.detection.get_map_feature_detections_controller(map_feature_id: Union[str, int], fields: Optional[list] = None)
+### mapillary.controller.detection.get_map_feature_detections_controller(map_feature_id: Union[str, int], fields: list = [])
 Get image detections with given (map feature) key
 
 

docs/docs/mapillary.controller/mapillary.controller.detection.md

@@ -160,8 +160,8 @@ the list of fields/properties to be returned
 
 
 
-### mapillary.controller.image.get_image_looking_at_controller(looker: dict, at: dict, filters: dict)
-Extracting the GeoJSON for the image data from a ‘looker’ and ‘at’ coordinate view
+### mapillary.controller.image.get_image_looking_at_controller(at: Union[dict, Coordinates, list], filters: dict)
+Checks if the image with coordinates ‘at’ is looked with the given filters.
 
 
 * **Parameters**
@@ -170,7 +170,7 @@ Extracting the GeoJSON for the image data from a ‘looker’ and ‘at’ coord
     * **filters** (*dict*) – Filters to pass the data through
 
 
-    * **looker** (*dict*) – The dictionary of coordinates of the position of the looking from
+    * **at** (*dict*) – The dict of coordinates of the position of the looking at
     coordinates. Format:
 
     ```
@@ -182,16 +182,7 @@ Extracting the GeoJSON for the image data from a ‘looker’ and ‘at’ coord
 
 
 
-    * **at** (*dict*) – The dict of coordinates of the position of the looking at
-    coordinates. Format:
-
-    ```
-    >>> {
-    >>>     'lng': 'longitude',
-    >>>     'lat': 'latitude'
-    >>> }
-    ```
-
+    * **filters.zoom** (*int*) – The zoom level of the tiles to obtain, defaults to 14
 
 
     * **filters.min_captured_at** (*str*) – The minimum date to filter till
@@ -328,6 +319,57 @@ Reference,
 * [https://www.mapillary.com/developer/api-documentation/#coverage-tiles](https://www.mapillary.com/developer/api-documentation/#coverage-tiles)
 
 
+### mapillary.controller.image.is_image_being_looked_at_controller(at: Union[dict, Coordinates, list], filters: dict)
+Checks if the image with coordinates ‘at’ is looked with the given filters.
+
+
+* **Parameters**
+
+    
+    * **at** (*Union**[**dict**, **mapillary.models.geojson.Coordinates**, **list**]*) – The dict of coordinates of the position of the looking at coordinates. Format:
+
+    ```
+    >>> at_dict = {
+    ...     'lng': 'longitude',
+    ...     'lat': 'latitude'
+    ... }
+    >>> at_list = [12.954940544167, 48.0537894275]
+    >>> from mapillary.models.geojson import Coordinates
+    >>> at_coord: Coordinates = Coordinates(lng=12.954940544167, lat=48.0537894275)
+    ```
+
+
+    * **filters.zoom** – The zoom level of the tiles to obtain, defaults to 14
+
+
+    * **filters.min_captured_at** (*str*) – The minimum date to filter till
+
+
+    * **filters.max_captured_at** (*str*) – The maximum date to filter upto
+
+
+    * **filters.radius** (*float*) – The radius that the geometry points will lie in
+
+
+    * **filters.image_type** (*str*) – Either ‘pano’, ‘flat’ or ‘all’
+
+
+    * **filters.organization_id** (*str*) – The organization to retrieve the data for
+
+
+
+* **Returns**
+
+    True if the image is looked at by the given looker and at coordinates, False otherwise
+
+
+
+* **Return type**
+
+    bool
+
+
+
 ### mapillary.controller.image.shape_features_controller(shape, is_image: bool = True, filters: Optional[dict] = None)
 For extracting images that lie within a shape, merging the results of the found features
 into a single object - by merging all the features into one list in a feature collection.

docs/docs/mapillary.controller/mapillary.controller.image.md

@@ -43,7 +43,7 @@ Usage:
 ```
 
 
-#### fetch_detections(identity: int, id_type: bool = True, fields: Optional[list] = None)
+#### fetch_detections(identity: int, id_type: bool = True, fields: list = [])
 Fetches detections depending on the id, detections for either map_features or
 images and the fields provided
 

docs/docs/mapillary.models.api/mapillary.models.api.entities.md

@@ -0,0 +1,152 @@
+---
+sidebar position: 3
+---
+
+
+### mapillary.models.api.entities
+
+This module contains the Adapter design for the Entities API of Mapillary API v4.
+
+For more information, please check out [https://www.mapillary.com/developer/api-documentation/](https://www.mapillary.com/developer/api-documentation/).
+
+
+* Copyright: (c) 2021 Facebook
+
+
+* License: MIT LICENSE
+
+
+### class mapillary.models.api.general.GeneralAdapter(\*args: object)
+Bases: `object`
+
+General adaptor for using the API calls defined for the general module
+(mapillary.config.api.general)
+
+The GeneralAdaptor provides functions for getting preprocessed data from the API, through the
+API calls mentioned in the previously mentioned config.
+
+It performs parsing, property handling, easier logic for extracing information, focusing on
+adding a layer of abstraction by removing details of using mercantile, ast, et al, to
+focus on the inputs and outputs of functions
+
+Usage:
+
+```
+>>> import mapillary
+```
+
+
+#### fetch_computed_image_tiles(zoom: int, longitude: float, latitude: float, layer: Literal['overview', 'sequence', 'image', 'map_feature', 'traffic_sign'] = 'image')
+Get the image type for a given image.
+
+
+* **Parameters**
+
+    
+    * **zoom** (*int*) – The zoom to get the image type for.
+
+
+    * **longitude** (*float*) – The longitude of the image.
+
+
+    * **latitude** (*float*) – The latitude of the image.
+
+
+
+* **Returns**
+
+    A dictionary containing the image type for the image.
+
+
+
+* **Return type**
+
+    dict
+
+
+
+#### fetch_image_tiles(zoom: int, longitude: float, latitude: float, layer: Literal['overview', 'sequence', 'image', 'map_feature', 'traffic_sign'] = 'image')
+Get the tiles for a given image.
+
+
+* **Parameters**
+
+    
+    * **zoom** (*int*) – Zoom level of the image.
+
+
+    * **longitude** (*float*) – Longitude of the image
+
+
+    * **latitude** (*float*) – Latitude of the image
+
+
+
+* **Returns**
+
+    A dictionary containing the tiles for the image.
+
+
+
+* **Return type**
+
+    dict
+
+
+
+#### fetch_map_features_tiles(zoom: int, longitude: float, latitude: float, layer: Literal['overview', 'sequence', 'image', 'map_feature', 'traffic_sign'] = 'image')
+Get the map features for a given coordinate set
+
+
+* **Parameters**
+
+    
+    * **zoom** (*int*) – The zoom value to get the map features for
+
+
+    * **longitude** (*float*) – The longitude of the image
+
+
+    * **latitude** (*float*) – The latitude of the image
+
+
+
+* **Returns**
+
+    A dictionary containing the map features for the image.
+
+
+
+* **Return type**
+
+    dict
+
+
+
+#### fetch_map_features_traffic_tiles(zoom: int, longitude: float, latitude: float, layer: str)
+Get the map feature traffic for a given coordinate set
+
+
+* **Parameters**
+
+    
+    * **zoom** (*int*) – The zoom value to get the map features for
+
+
+    * **longitude** (*float*) – The longitude of the image
+
+
+    * **latitude** (*float*) – The latitude of the image
+
+
+
+* **Returns**
+
+    A dictionary containing the map features for the image.
+
+
+
+* **Return type**
+
+    dict
+