Skip to content

Commit c796e18

Browse files
binaryseedbinaryseed
committed
Naming convention
1 parent d85e48f commit c796e18

16 files changed

Lines changed: 161 additions & 158 deletions

‎docs/layer_groups.ipynb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020
" create_map,\n",
2121
" delete_map,\n",
2222
" list_layer_groups,\n",
23-
" get_layer_group_details,\n",
23+
" get_layer_group,\n",
2424
" update_layer_groups,\n",
2525
" delete_layer_group,\n",
2626
" publish_layer_group,\n",
2727
" update_layers,\n",
28-
" get_layer_details,\n",
28+
" get_layer,\n",
2929
" upload_file\n",
3030
")\n",
3131
"\n",
@@ -88,10 +88,10 @@
8888
"layer2_id = layer2_resp[\"layer_id\"]\n",
8989
"\n",
9090
"# Wait for processing to complete\n",
91-
"while get_layer_details(map_id, layer1_id)[\"progress\"] < 100:\n",
91+
"while get_layer(map_id, layer1_id)[\"progress\"] < 100:\n",
9292
" print(\"Waiting for layer to finish processing...\")\n",
9393
" time.sleep(5)",
94-
"while get_layer_details(map_id, layer2_id)[\"progress\"] < 100:\n",
94+
"while get_layer(map_id, layer2_id)[\"progress\"] < 100:\n",
9595
" print(\"Waiting for layer to finish processing...\")\n",
9696
" time.sleep(5)",
9797
"print(\"Layers ready...\")\n"
@@ -162,7 +162,7 @@
162162
"source": [
163163
"# Get details for the first group\n",
164164
"group_id = created_groups[0][\"id\"]\n",
165-
"group_details = get_layer_group_details(map_id, group_id)\n",
165+
"group_details = get_layer_group(map_id, group_id)\n",
166166
"group_details"
167167
]
168168
},

‎docs/layers.ipynb‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@
2121
"from felt_python import (\n",
2222
" create_map,\n",
2323
" delete_map,\n",
24-
" get_map_details,\n",
24+
" get_map,\n",
2525
" list_layers,\n",
2626
" upload_file,\n",
2727
" upload_url,\n",
2828
" upload_dataframe,\n",
2929
" upload_geodataframe,\n",
3030
" refresh_file_layer,\n",
3131
" refresh_url_layer,\n",
32-
" get_layer_details,\n",
32+
" get_layer,\n",
3333
" update_layer_style,\n",
3434
" get_export_link,\n",
3535
" download_layer,\n",
@@ -76,7 +76,7 @@
7676
"metadata": {},
7777
"outputs": [],
7878
"source": [
79-
"get_map_details(map_id)"
79+
"get_map(map_id)"
8080
]
8181
},
8282
{
@@ -137,7 +137,7 @@
137137
"outputs": [],
138138
"source": [
139139
"# Wait for layer processing\n",
140-
"while get_layer_details(map_id, layer_id)[\"progress\"] < 100:\n",
140+
"while get_layer(map_id, layer_id)[\"progress\"] < 100:\n",
141141
" print(\"Waiting for layer to finish processing...\")\n",
142142
" time.sleep(5)",
143143
"refresh_file_layer(map_id, layer_id, file_name=\"fixtures/null-island-points.geojson\")"
@@ -180,7 +180,7 @@
180180
"metadata": {},
181181
"outputs": [],
182182
"source": [
183-
"while get_layer_details(map_id, url_layer_id)[\"progress\"] < 100:\n",
183+
"while get_layer(map_id, url_layer_id)[\"progress\"] < 100:\n",
184184
" print(\"Waiting for layer to finish processing...\")\n",
185185
" time.sleep(5)\n",
186186
"refresh_url_layer(map_id, url_layer_id)"
@@ -209,7 +209,7 @@
209209
"metadata": {},
210210
"outputs": [],
211211
"source": [
212-
"current_style = get_layer_details(map_id, layer_id)[\"style\"]\n",
212+
"current_style = get_layer(map_id, layer_id)[\"style\"]\n",
213213
"current_style"
214214
]
215215
},

‎docs/library.ipynb‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
" create_map,\n",
2222
" delete_map,\n",
2323
" upload_file,\n",
24-
" get_layer_details,\n",
24+
" get_layer,\n",
2525
" publish_layer\n",
2626
")\n",
2727
"\n",
@@ -106,7 +106,7 @@
106106
"layer_id = layer_resp[\"layer_id\"]\n",
107107
"\n",
108108
"# Wait for layer processing\n",
109-
"while get_layer_details(map_id, layer_id)[\"progress\"] < 100:\n",
109+
"while get_layer(map_id, layer_id)[\"progress\"] < 100:\n",
110110
" print(\"Waiting for layer to finish processing...\")\n",
111111
" time.sleep(5)",
112112
"print(\"Layer ready...\")\n"

‎docs/maps.ipynb‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,12 @@
1818
"from felt_python import (\n",
1919
" create_map,\n",
2020
" delete_map,\n",
21-
" get_map_details,\n",
21+
" get_map,\n",
2222
" update_map,\n",
2323
" move_map,\n",
24+
" export_comments,\n",
25+
" resolve_comment,\n",
26+
" delete_comment,\n",
2427
" create_embed_token,\n",
2528
" add_source_layer\n",
2629
")\n",
@@ -68,7 +71,7 @@
6871
"metadata": {},
6972
"outputs": [],
7073
"source": [
71-
"get_map_details(map_id)"
74+
"get_map(map_id)"
7275
]
7376
},
7477
{
@@ -113,6 +116,7 @@
113116
"# Export comments as JSON (default)\n",
114117
"comments_json = export_comments(map_id)\n",
115118
"print(f\"Number of comment threads: {len(comments_json)}\")\n",
119+
"comments_json\n",
116120
"\n",
117121
"# Export comments as CSV\n",
118122
"# comments_csv = export_comments(map_id, format=\"csv\")"

‎docs/projects.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"from felt_python import (\n",
1919
" list_projects,\n",
2020
" create_project,\n",
21-
" get_project_details,\n",
21+
" get_project,\n",
2222
" update_project,\n",
2323
" delete_project,\n",
2424
" create_map,\n",
@@ -80,7 +80,7 @@
8080
"metadata": {},
8181
"outputs": [],
8282
"source": [
83-
"project_details = get_project_details(project_id)\n",
83+
"project_details = get_project(project_id)\n",
8484
"project_details"
8585
]
8686
},
@@ -151,7 +151,7 @@
151151
"metadata": {},
152152
"outputs": [],
153153
"source": [
154-
"project_with_map = get_project_details(project_id)\n",
154+
"project_with_map = get_project(project_id)\n",
155155
"project_maps = project_with_map.get(\"maps\", [])\n",
156156
"print(f\"Number of maps in project: {len(project_maps)}\")\n",
157157
"\n",

‎docs/sources.ipynb‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
"from felt_python import (\n",
1919
" list_sources,\n",
2020
" create_source,\n",
21-
" get_source_details,\n",
21+
" get_source,\n",
2222
" update_source,\n",
2323
" delete_source,\n",
2424
" sync_source,\n",
@@ -126,7 +126,7 @@
126126
"metadata": {},
127127
"outputs": [],
128128
"source": [
129-
"source_details = get_source_details(source_id)\n",
129+
"source_details = get_source(source_id)\n",
130130
"source_details"
131131
]
132132
},
@@ -200,7 +200,7 @@
200200
"# Wait for source synchronization to complete\n",
201201
"import time\n",
202202
"for i in range(60): # Wait up to 5 minutes\n",
203-
" current_source = get_source_details(source_id)\n",
203+
" current_source = get_source(source_id)\n",
204204
" if current_source[\"sync_status\"] == \"completed\":\n",
205205
" break\n",
206206
" print(f\"Waiting for source sync... Status: {current_source['sync_status']}\")\n",

‎felt_python/__init__.py‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22
from .maps import (
33
create_map,
44
delete_map,
5-
get_map_details,
5+
get_map,
66
update_map,
77
move_map,
88
create_embed_token,
99
add_source_layer,
10+
# Deprecated
11+
get_map_details,
1012
)
1113
from .exceptions import AuthError
1214
from .layers import (
@@ -17,7 +19,7 @@
1719
upload_url,
1820
refresh_file_layer,
1921
refresh_url_layer,
20-
get_layer_details,
22+
get_layer,
2123
update_layer_style,
2224
get_export_link,
2325
download_layer,
@@ -42,22 +44,22 @@
4244
)
4345
from .layer_groups import (
4446
list_layer_groups,
45-
get_layer_group_details,
47+
get_layer_group,
4648
update_layer_groups,
4749
delete_layer_group,
4850
publish_layer_group,
4951
)
5052
from .projects import (
5153
list_projects,
5254
create_project,
53-
get_project_details,
55+
get_project,
5456
update_project,
5557
delete_project,
5658
)
5759
from .sources import (
5860
list_sources,
5961
create_source,
60-
get_source_details,
62+
get_source,
6163
update_source,
6264
delete_source,
6365
sync_source,
@@ -81,7 +83,6 @@
8183
# Maps
8284
"create_map",
8385
"delete_map",
84-
"get_map_details",
8586
"update_map",
8687
"move_map",
8788
"create_embed_token",
@@ -94,7 +95,7 @@
9495
"upload_url",
9596
"refresh_file_layer",
9697
"refresh_url_layer",
97-
"get_layer_details",
98+
"get_layer",
9899
"update_layer_style",
99100
"get_export_link",
100101
"download_layer",
@@ -106,7 +107,7 @@
106107
"duplicate_layers",
107108
# Layer groups
108109
"list_layer_groups",
109-
"get_layer_group_details",
110+
"get_layer_group",
110111
"update_layer_groups",
111112
"delete_layer_group",
112113
"publish_layer_group",
@@ -117,19 +118,16 @@
117118
"upsert_elements",
118119
"delete_element",
119120
"create_element_groups",
120-
# Elements deprecated:
121-
"post_elements",
122-
"post_element_group",
123121
# Projects
124122
"list_projects",
125123
"create_project",
126-
"get_project_details",
124+
"get_project",
127125
"update_project",
128126
"delete_project",
129127
# Sources
130128
"list_sources",
131129
"create_source",
132-
"get_source_details",
130+
"get_source",
133131
"update_source",
134132
"delete_source",
135133
"sync_source",
@@ -143,4 +141,8 @@
143141
"get_current_user",
144142
# Exceptions
145143
"AuthError",
144+
# Deprecated
145+
"post_elements",
146+
"post_element_group",
147+
"get_map_details",
146148
]

‎felt_python/comments.py‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,23 @@
77
from .api import make_request, BASE_URL
88

99

10-
MAP_COMMENTS_TEMPLATE = urljoin(BASE_URL, "maps/{map_id}/comments/")
11-
MAP_COMMENT_TEMPLATE = urljoin(MAP_COMMENTS_TEMPLATE, "{comment_id}")
12-
MAP_COMMENT_RESOLVE_TEMPLATE = urljoin(MAP_COMMENT_TEMPLATE, "/resolve")
13-
MAP_COMMENTS_EXPORT_TEMPLATE = urljoin(MAP_COMMENTS_TEMPLATE, "export")
10+
COMMENT = urljoin(BASE_URL, "maps/{map_id}/comments/{comment_id}")
11+
COMMENT_RESOLVE = urljoin(BASE_URL, "maps/{map_id}/comments/{comment_id}/resolve")
12+
COMMENT_EXPORT = urljoin(BASE_URL, "maps/{map_id}/comments/{comment_id}/export")
1413

1514

1615
def export_comments(map_id: str, format: str = "json", api_token: str | None = None):
1716
"""Export comments from a map
18-
17+
1918
Args:
2019
map_id: The ID of the map to export comments from
2120
format: The format to export the comments in, either 'csv' or 'json' (default)
2221
api_token: Optional API token
23-
22+
2423
Returns:
2524
The exported comments in the specified format
2625
"""
27-
url = f"{MAP_COMMENTS_EXPORT_TEMPLATE.format(map_id=map_id)}?format={format}"
26+
url = f"{COMMENT_EXPORT.format(map_id=map_id)}?format={format}"
2827
response = make_request(
2928
url=url,
3029
method="GET",
@@ -35,17 +34,17 @@ def export_comments(map_id: str, format: str = "json", api_token: str | None = N
3534

3635
def resolve_comment(map_id: str, comment_id: str, api_token: str | None = None):
3736
"""Resolve a comment
38-
37+
3938
Args:
4039
map_id: The ID of the map that contains the comment
4140
comment_id: The ID of the comment to resolve
4241
api_token: Optional API token
43-
42+
4443
Returns:
4544
Confirmation of the resolved comment
4645
"""
4746
response = make_request(
48-
url=MAP_COMMENT_RESOLVE_TEMPLATE.format(map_id=map_id, comment_id=comment_id),
47+
url=COMMENT_RESOLVE.format(map_id=map_id, comment_id=comment_id),
4948
method="POST",
5049
api_token=api_token,
5150
)
@@ -54,14 +53,14 @@ def resolve_comment(map_id: str, comment_id: str, api_token: str | None = None):
5453

5554
def delete_comment(map_id: str, comment_id: str, api_token: str | None = None):
5655
"""Delete a comment
57-
56+
5857
Args:
5958
map_id: The ID of the map that contains the comment
6059
comment_id: The ID of the comment to delete
6160
api_token: Optional API token
6261
"""
6362
make_request(
64-
url=MAP_COMMENT_TEMPLATE.format(map_id=map_id, comment_id=comment_id),
63+
url=COMMENT.format(map_id=map_id, comment_id=comment_id),
6564
method="DELETE",
6665
api_token=api_token,
6766
)

0 commit comments

Comments
 (0)