PR feedback

Author: binaryseed

README.md

@@ -23,9 +23,9 @@ refreshing files and (Geo)DataFrames or updating layer styles and element proper
 pip install felt-python
 ```
 
-## Documentation
+## Notebooks
 
-See the [docs](/docs) directory for Juypter notebooks with complete examples of using the API.
+See the [notebooks](/notebooks) directory for Juypter notebooks with complete examples of using the API.
 
 ## Basic Usage
 
@@ -68,5 +68,60 @@ upload = upload_file(
 layer_id = upload["layer_id"]
 ```
 
+### Uploading a Pandas DataFrame
+```python
+import pandas as pd
+from felt_python import upload_dataframe
+
+df = pd.read_csv("path/to/file.csv")
+upload_dataframe(
+    map_id=map_id,
+    dataframe=df,
+    layer_name="Felt <3 Pandas",
+)
+```
+
+### Uploading a GeoPandas GeoDataFrame
+```python
+import geopandas as gpd
+from felt_python import upload_geodataframe
+
+gdf = gpd.read_file("path/to/file.shp")
+upload_geodataframe(
+    map_id=map_id,
+    geodataframe=gdf,
+    layer_name="Felt <3 GeoPandas",
+)
+```
+
+### Refreshing a layer
+```python
+from felt_python import refresh_file_layer
+
+refresh_file_layer(
+    map_id=map_id,
+    layer_id=layer_id,
+    file_path="path/to/new_file.csv",
+)
+```
+
+### Styling a layer
+```python
+from felt_python import get_layer_details, update_layer_style
+
+current_style = get_layer_details(
+    map_id=map_id,
+    layer_id=layer_id,
+)["style"]
+new_style = current_style.copy()
+new_style["color"] = "#FF0000"
+new_style["size"] = 20
+update_layer_style(
+    map_id=map_id,
+    layer_id=layer_id,
+    style=new_style,
+)
+```
+
 ## Support
 We are always eager to hear from you. Reach out to [email protected] for all your Felt support needs.

felt_python/__init__.py

@@ -35,7 +35,7 @@
     list_element_groups,
     upsert_elements,
     delete_element,
-    show_element_group,
+    get_element_group,
     create_element_groups,
     # Deprecated:
     post_elements,

felt_python/elements.py

@@ -1,7 +1,6 @@
 """Elements and element groups"""
 
 import json
-from typing import Dict, Any, List, Union
 
 from urllib.parse import urljoin
 
@@ -51,10 +50,8 @@ def list_element_groups(map_id: str, api_token: str | None = None):
     return json.load(response)
 
 
-def show_element_group(
-    map_id: str, element_group_id: str, api_token: str | None = None
-):
-    """Show all elements in a group
+def get_element_group(map_id: str, element_group_id: str, api_token: str | None = None):
+    """Get contents of an element group
 
     Args:
         map_id: The ID of the map containing the group
@@ -72,11 +69,11 @@ def show_element_group(
     return json.load(response)
 
 
-@deprecated(reason="Please use `show_element_group` instead")
+@deprecated(reason="Please use `get_element_group` instead")
 def list_elements_in_group(
     map_id: str, element_group_id: str, api_token: str | None = None
 ):
-    show_element_group(map_id, element_group_id, api_token)
+    get_element_group(map_id, element_group_id, api_token)
 
 
 @deprecated(reason="Please use `upsert_elements` instead")
@@ -140,7 +137,7 @@ def post_element_group(
 
 def create_element_groups(
     map_id: str,
-    element_groups: List[Dict[str, Any]],
+    element_groups: list[dict[str, str]],
     api_token: str | None = None,
 ):
     """Post multiple element groups

felt_python/layer_groups.py

@@ -1,7 +1,6 @@
 """Layer groups"""
 
 import json
-from typing import Dict, Any, List, Union, Optional
 
 from urllib.parse import urljoin
 
@@ -58,7 +57,7 @@ def get_layer_group(
 
 def update_layer_groups(
     map_id: str,
-    layer_group_params_list: List[Dict[str, Any]],
+    layer_group_params_list: list[dict[str, str | int]],
     api_token: str | None = None,
 ):
     """Update multiple layer groups at once

felt_python/layers.py

@@ -7,7 +7,7 @@
 import typing
 import urllib.request
 import uuid
-from typing import Dict, Any, List, Union, Optional
+import typing
 
 from urllib.parse import urljoin
 
@@ -38,37 +38,12 @@ def list_layers(map_id: str, api_token: str | None = None):
     return json.load(response)
 
 
-def _multipart_request(
-    url: str, presigned_attributes: dict[str, str], file_obj: typing.IO[bytes]
-) -> urllib.request.Request:
-    """Make a multipart/form-data request with the given file"""
-    boundary = "-" * 20 + str(uuid.uuid4())
-    headers = {"Content-Type": f'multipart/form-data; boundary="{boundary}"'}
-    fname = os.path.basename(file_obj.name)
-
-    data = io.BytesIO()
-    text = io.TextIOWrapper(data, encoding="latin-1")
-    for key, value in presigned_attributes.items():
-        text.write(f"--{boundary}\r\n")
-        text.write(f'Content-Disposition: form-data; name="{key}"\r\n\r\n')
-        text.write(f"{value}\r\n")
-    text.write(f"--{boundary}\r\n")
-    text.write(f'Content-Disposition: form-data; name="file"; filename="{fname}"\r\n')
-    text.write("Content-Type: application/octet-stream\r\n\r\n")
-    text.flush()
-    data.write(file_obj.read())
-    data.write(f"\r\n--{boundary}".encode("latin-1"))
-    body = data.getvalue()
-
-    return urllib.request.Request(url, data=body, headers=headers, method="POST")
-
-
 def upload_file(
     map_id: str,
     file_name: str,
     layer_name: str,
-    metadata: Dict[str, Any] = None,
-    hints: List[Dict[str, Any]] = None,
+    metadata: dict[str, str] = None,
+    hints: list[dict[str, str]] = None,
     lat: float = None,
     lng: float = None,
     zoom: float = None,
@@ -109,23 +84,16 @@ def upload_file(
         api_token=api_token,
         json=json_payload,
     )
-    presigned_upload = json.load(response)
-    url = presigned_upload["url"]
-    presigned_attributes = presigned_upload["presigned_attributes"]
 
-    with open(file_name, "rb") as file_obj:
-        request = _multipart_request(url, presigned_attributes, file_obj)
-        urllib.request.urlopen(request)
-
-    return presigned_upload
+    return _upload_file(json.load(response), file_name)
 
 
 def upload_dataframe(
     map_id: str,
     dataframe: "pd.DataFrame",
     layer_name: str,
-    metadata: Dict[str, Any] = None,
-    hints: List[Dict[str, Any]] = None,
+    metadata: dict[str, str] = None,
+    hints: list[dict[str, str]] = None,
     api_token: str | None = None,
 ):
     """Upload a Pandas DataFrame to a Felt map"""
@@ -146,8 +114,8 @@ def upload_geodataframe(
     map_id: str,
     geodataframe: "gpd.GeoDataFrame",
     layer_name: str,
-    metadata: Dict[str, Any] = None,
-    hints: List[Dict[str, Any]] = None,
+    metadata: dict[str, str] = None,
+    hints: list[dict[str, str]] = None,
     api_token: str | None = None,
 ):
     """Upload a GeoPandas GeoDataFrame to a Felt map"""
@@ -183,23 +151,15 @@ def refresh_file_layer(
         method="POST",
         api_token=api_token,
     )
-    presigned_upload = json.load(response)
-    url = presigned_upload["url"]
-    presigned_attributes = presigned_upload["presigned_attributes"]
-
-    with open(file_name, "rb") as file_obj:
-        request = _multipart_request(url, presigned_attributes, file_obj)
-        urllib.request.urlopen(request)
-
-    return presigned_upload
+    return _upload_file(json.load(response), file_name)
 
 
 def upload_url(
     map_id: str,
     layer_url: str,
     layer_name: str,
-    metadata: Dict[str, Any] = None,
-    hints: List[Dict[str, Any]] = None,
+    metadata: dict[str, str] = None,
+    hints: list[dict[str, str]] = None,
     api_token: str | None = None,
 ):
     """Upload a URL to a Felt map
@@ -324,7 +284,7 @@ def download_layer(
 
 def update_layers(
     map_id: str,
-    layer_params_list: List[Dict[str, Any]],
+    layer_params_list: list[dict[str, object]],
     api_token: str | None = None,
 ):
     """Update multiple layers at once
@@ -396,7 +356,7 @@ def create_custom_export(
     map_id: str,
     layer_id: str,
     output_format: str,
-    filters: List[Dict[str, Any]] = None,
+    filters: list = None,
     email_on_completion: bool = True,
     api_token: str | None = None,
 ):
@@ -462,7 +422,7 @@ def get_custom_export_status(
 
 
 def duplicate_layers(
-    duplicate_params: List[Dict[str, str]], api_token: str | None = None
+    duplicate_params: list[dict[str, str]], api_token: str | None = None
 ):
     """Duplicate layers from one map to another
 
@@ -486,3 +446,38 @@ def duplicate_layers(
         api_token=api_token,
     )
     return json.load(response)
+
+
+def _upload_file(presigned_upload, file_name):
+    url = presigned_upload["url"]
+    presigned_attributes = presigned_upload["presigned_attributes"]
+
+    with open(file_name, "rb") as file_obj:
+        request = _multipart_request(url, presigned_attributes, file_obj)
+        urllib.request.urlopen(request)
+    return presigned_upload
+
+
+def _multipart_request(
+    url: str, presigned_attributes: dict[str, str], file_obj: typing.IO[bytes]
+) -> urllib.request.Request:
+    """Make a multipart/form-data request with the given file"""
+    boundary = "-" * 20 + str(uuid.uuid4())
+    headers = {"Content-Type": f'multipart/form-data; boundary="{boundary}"'}
+    fname = os.path.basename(file_obj.name)
+
+    data = io.BytesIO()
+    text = io.TextIOWrapper(data, encoding="latin-1")
+    for key, value in presigned_attributes.items():
+        text.write(f"--{boundary}\r\n")
+        text.write(f'Content-Disposition: form-data; name="{key}"\r\n\r\n')
+        text.write(f"{value}\r\n")
+    text.write(f"--{boundary}\r\n")
+    text.write(f'Content-Disposition: form-data; name="file"; filename="{fname}"\r\n')
+    text.write("Content-Type: application/octet-stream\r\n\r\n")
+    text.flush()
+    data.write(file_obj.read())
+    data.write(f"\r\n--{boundary}".encode("latin-1"))
+    body = data.getvalue()
+
+    return urllib.request.Request(url, data=body, headers=headers, method="POST")

felt_python/maps.py

@@ -1,7 +1,6 @@
 """Maps"""
 
 import json
-from typing import Dict, Any, List, Union, Optional
 
 from urllib.parse import urljoin
 
@@ -25,7 +24,7 @@ def create_map(
     lat: float = None,
     lon: float = None,
     zoom: float = None,
-    layer_urls: List[str] = None,
+    layer_urls: list[str] = None,
     workspace_id: str = None,
     api_token: str = None,
 ):
@@ -208,7 +207,7 @@ def create_embed_token(map_id: str, user_email: str = None, api_token: str = Non
 
 
 def add_source_layer(
-    map_id: str, source_layer_params: Dict[str, Any], api_token: str = None
+    map_id: str, source_layer_params: dict[str, str], api_token: str = None
 ):
     """Add a layer from a source to a map
 

felt_python/sources.py

@@ -3,7 +3,6 @@
 import json
 
 from urllib.parse import urljoin
-from typing import Dict, Any, List, Union
 
 from .api import make_request, BASE_URL
 
@@ -29,8 +28,8 @@ def list_sources(workspace_id: str | None = None, api_token: str | None = None):
 
 def create_source(
     name: str,
-    connection: Dict[str, Any],
-    permissions: Dict[str, Any] = None,
+    connection: dict[str, str],
+    permissions: dict[str, str] = None,
     api_token: str | None = None,
 ):
     """Create a new source
@@ -70,8 +69,8 @@ def get_source(source_id: str, api_token: str | None = None):
 def update_source(
     source_id: str,
     name: str | None = None,
-    connection: Dict[str, Any] | None = None,
-    permissions: Dict[str, Any] | None = None,
+    connection: dict[str, str] | None = None,
+    permissions: dict[str, str] | None = None,
     api_token: str | None = None,
 ):
     """Update a source's details

docs/elements.ipynb notebooks/elements.ipynbdocs/elements.ipynb renamed to notebooks/elements.ipynb

@@ -20,7 +20,7 @@
     "    delete_map,\n",
     "    list_elements,\n",
     "    list_element_groups,\n",
-    "    show_element_group,\n",
+    "    get_element_group,\n",
     "    upsert_elements,\n",
     "    delete_element,\n",
     "    create_element_groups\n",
@@ -230,7 +230,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "group_elements = show_element_group(map_id, element_group_id)\n",
+    "group_elements = get_element_group(map_id, element_group_id)\n",
     "group_elements"
    ]
   },