sopel-ai 1.1.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

{sopel_ai-1.1.0.dist-info → sopel_ai-1.2.0.dist-info}/METADATA

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: sopel-ai
-Version: 1.1.0
+Version: 1.2.0
 Summary: Sopel AI - an LLM enhanced chat bot plug-in
 Author-email: The SopelAI team <sopel_ai@cime.net>
+License: BSD-3-Clause
 Project-URL: Homepage, https://github.com/pr3d4t0r/sopel_ai
 Project-URL: Bug Tracker, https://github.com/pr3d4t0r/sopel_ai/issues
 Keywords: ai,bot,irc,llm,plugin,sopel
@@ -23,7 +24,7 @@ Requires-Dist: perplexipy
 Requires-Dist: sopel (>=7.1)
 Requires-Dist: tinydb
 
-% sopel_ai(1) Version 1.1.0 chatbot plugin
+% sopel_ai(1) Version 1.2.0 chatbot plugin
 
 Name
 ====
@@ -151,6 +152,52 @@ llm_key = pplx-3a45enteryourkeykere
 ```
 
 
+Docker
+======
+Sopel AI is dockerized and available from Docker Hub as pr3d4t0r/sopel_ai.  The
+version tag is the same as the latest version number for Sopel AI.
+
+The examples in this section assume execution from the local file system.  Adapt
+as needed to run in a Kubernets cluster or other deployment method.
+
+
+### First time
+
+The Sopel + AI configuration file must be created:
+
+```bash
+docker run -ti -v ${HOME}/sopel_ai_data:/home/sopel_ai \
+    pr3d4t0r/sopel_ai:latest \
+    sopel configure
+```
+
+The API key and other relevant configuration data must be provided at this time.
+`$HOME/sopel_ai_data` is volume mapped to the container's `/home/sopel_ai/.sopel
+directory.  Ensure that your host has write permissions in the shared volume.
+
+The `pr3d4t0r/sopel_ai:latest` image is used if no version is specified.  The
+image update policy is left to the sysops and is not automatic.
+
+Once `$HOME/sopel_ai_data` exists it's possible to copy the contents of a
+different `~/.sopel` directory to it and use is as the configuration and Sopel
+AI database store.
+
+
+### Starting Sopel AI
+
+A Docker Compose file is provided as an example of how to start the service,
+<a href='./dockerized/docker-compose.yaml' target='_blank'>docker-file.yaml</a>.  With this Docker Compose
+file in the current directory, start the service with:
+
+```bash
+docker-compose up [-d] sopel_ai
+
+```
+
+The `-d` parameter daemonizes the service.  Without it, the service will start
+and display its output in the current console.
+
+
 License
 =======
 The **Sopel AI** Sopel plugin, package, documentation, and examples are licensed

{sopel_ai-1.1.0.dist-info → sopel_ai-1.2.0.dist-info}/RECORD

@@ -3,9 +3,9 @@ sopel_ai/config.py,sha256=y0vbvfeDjjfLUOvTJ3W56mAGVpJxeizrXJbCaFW4ZXk,867
 sopel_ai/core.py,sha256=r5lnH8lcXenc2Ln3Qha2hoAggWUP5ZyZniZrdl9IIsQ,7240
 sopel_ai/errors.py,sha256=XMVgFk4Rw64Z0UO3ZInp-N6LP0GRG8NFIuXKnhu5rLo,192
 sopel_ai/plugin.py,sha256=51mYp6B_mUtgS6mL-IMhK8Qiz_Rw_qAwmTLdML-qQ2o,6800
-sopel_ai-1.1.0.dist-info/LICENSE.txt,sha256=I8aHapysmbM9F3y-rUfp011GQoosNO5L8pzl7IKgPnE,1531
-sopel_ai-1.1.0.dist-info/METADATA,sha256=niUEpHboA7k6c-LzYeoRyEvwVFSOps_2LWBbQzlUEJY,4681
-sopel_ai-1.1.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
-sopel_ai-1.1.0.dist-info/entry_points.txt,sha256=7Juxcn6L4j6F83TjkviiTwiyXLM4gZxAAXFQDR2G_m4,43
-sopel_ai-1.1.0.dist-info/top_level.txt,sha256=kpNMzNEGbhCXkyn7oc3uQPmrX1J6qLxn59IcZBpwSYg,9
-sopel_ai-1.1.0.dist-info/RECORD,,
+sopel_ai-1.2.0.dist-info/LICENSE.txt,sha256=I8aHapysmbM9F3y-rUfp011GQoosNO5L8pzl7IKgPnE,1531
+sopel_ai-1.2.0.dist-info/METADATA,sha256=mzBWiQuuRZjTrk9efPFkhOXnvUr7PmAz7lttRYazRtc,6200
+sopel_ai-1.2.0.dist-info/WHEEL,sha256=2wepM1nk4DS4eFpYrW1TTqPcoGNfHhhO_i5m4cOimbo,92
+sopel_ai-1.2.0.dist-info/entry_points.txt,sha256=7Juxcn6L4j6F83TjkviiTwiyXLM4gZxAAXFQDR2G_m4,43
+sopel_ai-1.2.0.dist-info/top_level.txt,sha256=kpNMzNEGbhCXkyn7oc3uQPmrX1J6qLxn59IcZBpwSYg,9
+sopel_ai-1.2.0.dist-info/RECORD,,