Preparing for release

RELEASING.md

+# Releasing
+
+When releasing a new version, a few things need to happen:
+
+* run black (python formatter) on the python files
+  * `$ black **/*.py`
+* Update the variable in both the server and client, in
+  * `__version__` in [django-torque-semantic-search/semantic_search/version.py]
+  * `$EDITOR django-torque-semantic-search/semantic_search/version.py`
+* commit the version update
+* tag the release in git
+* push to origin
+
+* release the client to pypi (see [the official pypi documentation](https://packaging.python.org/en/latest/tutorials/packaging-projects/) for more information):
+  * This requires a pypi login as well as access to the django-torque-semantic-search project
+  * Run `python3 -m build` from inside the `django-torque-semantic-search`
+  * Upload it to the normal pypi `python3 -m twine upload dist/*` from `django-torque-semantic-search`

django-torque-semantic-search/.gitignore

 dist
 *.egg-info/
+__pycache__

django-torque-semantic-search/semantic_search/receivers.py

@@ -48,10 +48,14 @@ def rebuild_semantic_search_index(sender, **kwargs):
     with transaction.atomic():
         semantic_sc_documents = []
 
-        for scd in torque_models.SearchCacheDocument.objects.filter(wiki_config=wiki_config):
-            document_dict = orjson.loads(torque_models.DocumentDictCache.objects.get(
-                document=scd.document, wiki_config=wiki_config
-            ).dictionary)["fields"]
+        for scd in torque_models.SearchCacheDocument.objects.filter(
+            wiki_config=wiki_config
+        ):
+            document_dict = orjson.loads(
+                torque_models.DocumentDictCache.objects.get(
+                    document=scd.document, wiki_config=wiki_config
+                ).dictionary
+            )["fields"]
             semantic_summary = build_semantic_summary(document_dict, scd.filtered_data)
             embeddings = llm.get_embeddings(semantic_summary)
 
@@ -67,7 +71,6 @@ def rebuild_semantic_search_index(sender, **kwargs):
         SemanticSearchCacheDocument.objects.bulk_create(semantic_sc_documents)
 
 
-
 @receiver(search_filter)
 def semantic_filter(sender, **kwargs):
     similarity = getattr(settings, "SEMANTIC_SEARCH_SIMILARITY", 0.7)

django-torque-semantic-search/semantic_search/utils.py

 from django.conf import settings
 
+
 def build_semantic_summary(document_dict, filtered_data):
     embedding_data = {}
 
@@ -17,4 +18,4 @@ def build_semantic_summary(document_dict, filtered_data):
         elif value:
             data_text += f"{name} is {value}. "
 
-    return data_text
+    return data_text
\ No newline at end of file

django-torque-semantic-search/semantic_search/version.py

+__version__ = "0.1.0"

django-torque-semantic-search/setup.py

@@ -2,12 +2,18 @@
 
 from distutils.core import setup
 
+# We read version from here to make it easier to read for outside scripts
+# (like release scripts)
+main_ns = {}
+with open("torque/version.py") as ver_file:
+    exec(ver_file.read(), main_ns)
+
 with open("README.md", "r", encoding="utf-8") as readme:
     long_description = readme.read()
 
 setup(
     name="django-torque-semantic-search",
-    version="0.1.0",
+    version=main_ns["__version__"],
     description="django app for torque semantic search",
     long_description=long_description,
     long_description_content_type="text/markdown",
@@ -29,6 +35,5 @@ setup(
         "orjson",
     ],
     package_dir={"": "."},
-    python_requres=">=3.11",
+    python_requires=">=3.11",
 )
-