Merge branch 'develop'

Release 3.3.9

Author: danmoraleswize

.github/workflows/publish.yaml

@@ -0,0 +1,30 @@
+name: Publish a new version to PyPI when a new release is published
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  pypi-publish:
+    name: Publish release to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/dnaStreaming
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.8"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel build
+      - name: Build package
+        run: |
+          python -m build
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.rst

@@ -41,7 +41,13 @@ To set your subscription ID, simply set an environment variable named 'SUBSCRIPT
     export SUBSCRIPTION_ID="ABC1234567889"
 
 
-The code above is the command line expression for setting this environment variable on Mac OSX. Other operating systems might have a slightly different techniques for setting environment variables on the command line.
+To set your log folder path, simply set this folder variable named 'LOG_PATH' like so
+
+.. code-block::
+
+    export LOG_PATH="/your/custom/log/path"
+
+
 
 2. Using the configuration file.
 ###################################################################
@@ -121,7 +127,25 @@ You may want to listen messages asynchronously like so:
 Log Files
 _________
 
-Very minimal logging is written to the module's path 'logs/dj-dna-streaming-python.log'. To keep maintenance simple this log is overwritten every time the app starts.
+
+Minimal logging is written to a file named `dj-dna-streaming-python.log`.
+
+By default, logs are written to the first available directory from the following list:
+
+1. A custom path set via the environment variable `LOG_PATH`.
+2. A `logs/` folder located within the package installation directory.
+3. A fallback directory: `~/.dj-dna-streaming-python/logs/`.
+
+The first writable location found is selected. A message like `Will log to: /your/custom/log/path` is printed to the console on startup.
+
+💡 The log file is overwritten each time the application starts to keep maintenance simple.
+
+You can specify:
+
+- **Absolute paths**: For example, `/var/log/dna-streaming`.
+- **Relative paths**: For example, `./logs`, relative to the current working directory at runtime.
+
+The code verifies that the specified path is writable. If it isn’t, it automatically falls back to the next available option.
 
 
 Testing

dnaStreaming/__init__.py

@@ -5,21 +5,37 @@
 import logging
 
 
-BASE_DIR = os.path.dirname(__file__)
+def get_log_path():
+    env_log_path = os.getenv("LOG_PATH")
+    fallback_log_dir = os.path.expanduser('~/.dj-dna-streaming-python/logs')
+    base_dir = os.path.dirname(__file__)
+    default_path = os.path.join(base_dir, 'logs')
+
+    candidates = [env_log_path, default_path, fallback_log_dir]
+
+    for path in candidates:
+        if path:
+            try:
+                os.makedirs(path, exist_ok=True)
+                testfile = os.path.join(path, '.write_test')
+                with open(testfile, 'w') as f:
+                    f.write('test')
+                os.remove(testfile)
+                return path
+            except Exception as e:
+                print(f"WARNING: Cannot write to '{path}': {e}")
+
+    raise RuntimeError("ERROR: Could not find a writable log directory.")
+
+
+log_path = get_log_path()
+print("Will log to: {}".format(log_path))
 
+# Logging setup
 logging.basicConfig(level=logging.WARN)
-
 logger = logging.getLogger()
 
-log_path = os.path.join(BASE_DIR, 'logs')
-
-print("Will log to: {}".format(log_path))
-
-if not os.path.exists(log_path):
-    os.mkdir(log_path)
-
-fileHandler = logging.FileHandler("{0}/{1}.log".format(log_path, 'dj-dna-streaming-python'))
-
+fileHandler = logging.FileHandler(os.path.join(log_path, 'dj-dna-streaming-python.log'))
 logFormatter = logging.Formatter("%(asctime)s [%(threadName)-12.12s] [%(levelname)-5.5s]  %(message)s")
 fileHandler.setFormatter(logFormatter)
 logger.addHandler(fileHandler)

tox.ini

@@ -4,7 +4,7 @@
 # and then run "tox" from this directory.
 
 [tox]
-envlist = py37
+envlist = py38
 
 [testenv]
 commands = py.test