feat(python): more guides

Author: Fluf22

templates/python/guides/search/deleteMultipleIndices.mustache

@@ -1,7 +1,7 @@
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
     # You need an API key with `deleteIndex`
     _{{> snippets/init}}
@@ -15,13 +15,13 @@ if __name__ == '__main__':
 
     # Delete primary indices first
     if primary_indices:
-      requests = [{'action': 'delete', 'indexName': index.name} for index in primary_indices]
+      requests = [{"action": "delete", "indexName": index.name} for index in primary_indices]
       {{#dynamicSnippet}}deleteMultipleIndicesPrimary{{/dynamicSnippet}}
       print("Deleted primary indices.")
 
     # Now, delete replica indices
     if replica_indices:
-      requests = [{'action': 'delete', 'indexName': index.name} for index in replica_indices]
+      requests = [{"action": "delete", "indexName": index.name} for index in replica_indices]
       {{#dynamicSnippet}}deleteMultipleIndicesReplica{{/dynamicSnippet}}
       print("Deleted replica indices.\n")
 

templates/python/guides/search/enableFilterPromote.mustache

@@ -0,0 +1,22 @@
+from algoliasearch.search.models.anchoring import Anchoring
+from algoliasearch.search.models.condition import Condition
+from algoliasearch.search.models.consequence import Consequence
+from algoliasearch.search.models.rule import Rule
+
+
+if __name__ == "__main__":
+  condition = Condition(
+    anchoring=Anchoring.IS,
+    pattern="{facet:brand}",
+  )
+
+  consequence = Consequence(
+    filter_promotes=True,
+  )
+
+  rule = Rule(
+    enabled=True,
+    object_id="rule_with_filterPromotes",
+    conditions=[condition],
+    consequence=consequence,
+  )

templates/python/guides/search/saveObjectsChunks.mustache

@@ -3,7 +3,7 @@ import json
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
     _{{> snippets/init}}
 

templates/python/guides/search/saveObjectsMCM.mustache

@@ -3,7 +3,7 @@
 def _get_all_app_id_configurations():
     return [] # A list of your MCM AppID/ApiKey pairs
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   playlists = [] # Your records
 
   # Fetch from your own data storage and with your own code

templates/python/guides/search/saveObjectsModified.mustache

@@ -3,7 +3,7 @@ import json
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
       _{{> snippets/init}}
 
@@ -13,14 +13,14 @@ if __name__ == '__main__':
           records = []
 
           for product in products:
-              reference = product['product_reference']
+              reference = product["product_reference"]
 
               suffixes = []
               while len(reference) > 1:
                   reference = reference[1:]
                   suffixes.append(reference)
 
-              product['product_reference_suffixes'] = suffixes
+              product["product_reference_suffixes"] = suffixes
               records.append(product)
 
       {{#dynamicSnippet}}saveObjectsRecords{{/dynamicSnippet}}

templates/python/guides/search/saveObjectsMovies.mustache

@@ -2,7 +2,7 @@ import requests
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     # Fetch sample dataset
     url = "https://dashboard.algolia.com/api/1/sample_datasets?type=movie"
     movies = requests.get(url).json()

templates/python/guides/search/saveObjectsPublicUser.mustache

@@ -1,7 +1,7 @@
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   playlists = [] # Your records
 
   try:

templates/python/guides/search/savePopularRecords.mustache

@@ -2,7 +2,7 @@
 from algoliasearch.search.models.browse_response import BrowseResponse
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
     _{{> snippets/init}}
 
@@ -11,9 +11,9 @@ if __name__ == '__main__':
       for hit in resp.hits:
         hit_dict = hit.to_dict()
         records.append({
-          'twitterHandle': hit_dict['twitterHandle'],
-          'nbFollowers': hit_dict['nbFollowers'],
-          'isPopular': hit_dict['nbFollowers'] > 1000000,
+          "twitterHandle": hit_dict["twitterHandle"],
+          "nbFollowers": hit_dict["nbFollowers"],
+          "isPopular": hit_dict["nbFollowers"] > 1000000,
         })
 
     _client.browse_objects(

templates/python/guides/search/searchInReplicaIndex.mustache

@@ -0,0 +1,16 @@
+{{> snippets/import}}
+
+
+if __name__ == "__main__":
+  _{{> snippets/init}}
+
+  query = "query"
+
+  # 1. Change the sort dynamically based on the UI events
+  sort_by_price = False
+
+  # 2. Get the index name based on sortByPrice
+  index_name = "products_price_desc" if sort_by_price else "products"
+
+  # 3. Search on dynamic index name (primary or replica)
+  {{#dynamicSnippet}}searchWithIndexNameVar{{/dynamicSnippet}}

templates/python/guides/search/searchRecentlyPublishedBooks.mustache

@@ -3,7 +3,7 @@ import time
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
     _{{> snippets/init}}
 

templates/python/guides/search/searchWithAnalyticsAndHeader.mustache

@@ -0,0 +1,21 @@
+{{> snippets/import}}
+from algoliasearch.search.models.search_params import SearchParams
+
+
+if __name__ == "__main__":
+  _{{> snippets/init}}
+
+  """
+  '94.228.178.246' should be replaced with your user's IP address.
+  Depending on your stack there are multiple ways to get this information.
+  """
+  ip = "94.228.178.246"
+  query = "query"
+
+  search_params = SearchParams(
+    query=query,
+    analytics=True,
+  )
+
+  {{#dynamicSnippet}}searchWithSearchParamsAndForwardedHeader{{/dynamicSnippet}}
+

templates/python/guides/search/searchWithGAToken.mustache

@@ -3,23 +3,23 @@
 
 def _get_google_analytics_user_id_from_browser_cookie(cookie_name: str) -> str:
     # Implement your logic here
-    return ''
+    return ""
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
     _{{> snippets/init}}
 
-    user_token = _get_google_analytics_user_id_from_browser_cookie('_ga')
+    user_token = _get_google_analytics_user_id_from_browser_cookie("_ga")
     search_params = {
-      'query': '<YOUR_SEARCH_QUERY>',
-      'userToken': user_token,
+      "query": "<YOUR_SEARCH_QUERY>",
+      "userToken": user_token,
     }
 
     {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
 
     logged_in_user = None
 
-    search_params['user_token'] = logged_in_user or user_token
+    search_params["user_token"] = logged_in_user or user_token
 
     {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}
   except Exception as e:

templates/python/guides/search/searchWithLogicalOr.mustache

@@ -0,0 +1,14 @@
+{{> snippets/import}}
+from algoliasearch.search.models.search_params import SearchParams
+
+
+if __name__ == "__main__":
+    _{{> snippets/init}}
+
+    query = "the query"
+    optional_words = ["the", "query"]
+    search_params = SearchParams(
+      query=query,
+      optional_words=optional_words,
+    )
+    {{#dynamicSnippet}}searchWithSearchParams{{/dynamicSnippet}}

templates/python/guides/search/searchWithOptionalFilters.mustache

@@ -6,7 +6,7 @@ def _reduce_labels_to_filters(_labels):
     # Implement your logic here
     return []
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   labels = [] # A list of labels
 
   try:

templates/python/guides/search/searchWithRuleContextBuyer.mustache

@@ -4,9 +4,9 @@ from algoliasearch.search.models.search_params import SearchParams
 
 def _get_buyer_account_id() -> str:
     # Implement your logic here
-    return ''
+    return ""
 
-if __name__ == '__main__':
+if __name__ == "__main__":
 
   try:
     _{{> snippets/init}}

templates/python/guides/search/searchWithRuleContexts.mustache

@@ -4,9 +4,9 @@ from algoliasearch.search.models.search_params import SearchParams
 
 def _get_platform_tag() -> str:
     # Implement your logic here
-    return ''
+    return ""
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   try:
     _{{> snippets/init}}
 

templates/python/guides/search/setHeaderUserIDThenSaveObjects.mustache

@@ -1,14 +1,14 @@
 {{> snippets/import}}
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   playlists = [] # Your records
 
   try:
     _{{> snippets/init}}
 
     for playlist in playlists:
-      playlist_user_id = playlist['userID']
+      playlist_user_id = playlist["userID"]
       {{#dynamicSnippet}}saveObjectsPlaylistsWithRequestOptions{{/dynamicSnippet}}
   except Exception as e:
     print(f"Error: {e}")

templates/python/guides/search/setSettingsThenSaveObjects.mustache

@@ -10,17 +10,17 @@ def _get_indexing_api_key_for(_user):
     # Implement your own logic here
     return ""
 
-if __name__ == '__main__':
+if __name__ == "__main__":
   playlists = [] # Your records
 
   try:
     for playlist in playlists:
-        app_id = _get_app_id_for(playlist['user'])
-        api_key = _get_indexing_api_key_for(playlist['user'])
+        app_id = _get_app_id_for(playlist["user"])
+        api_key = _get_indexing_api_key_for(playlist["user"])
 
         _client = SearchClientSync(app_id, api_key)
         settings = IndexSettings(
-          attributes_for_faceting=['filterOnly(user)']
+          attributes_for_faceting=["filterOnly(user)"]
         )
         {{#dynamicSnippet}}setSettings{{/dynamicSnippet}}
 

templates/python/guides/search/useConditionlessRule.mustache

@@ -0,0 +1,26 @@
+{{> snippets/import}}
+from algoliasearch.search.models.consequence import Consequence
+from algoliasearch.search.models.rule import Rule
+from algoliasearch.search.models.time_range import TimeRange
+
+if __name__ == "__main__":
+  _{{> snippets/init}}
+
+  object_id = "a-rule-id"
+
+  rule = Rule(
+    object_id=object_id,
+    consequence=Consequence(
+      # Set relevant consequence
+    ),
+  )
+
+  # Set validity (optional)
+  rule.validity = [
+    TimeRange(
+      var_from=1688774400,
+      until=1738972800,
+    ),
+  ]
+
+  {{#dynamicSnippet}}saveRule{{/dynamicSnippet}}