dnaStreaming 2.2.1.dev1__tar.gz → 2.3.0__tar.gz

{dnastreaming-2.2.1.dev1/dnaStreaming.egg-info → dnastreaming-2.3.0}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: dnaStreaming
-Version: 2.2.1.dev1
+Version: 2.3.0
 Summary: Dow Jones DNA Streaming Project
 Home-page: https://github.com/dowjones/dj-dna-streams-python
-Download-URL: https://github.com/dowjones/dj-dna-streams-python/archive/release-2.2.1.dev1.tar.gz
+Download-URL: https://github.com/dowjones/dj-dna-streams-python/archive/release-2.3.0.tar.gz
 Author: Zachary Kagan
 Author-email: zachary.kagan@dowjones.com
 License: MIT
@@ -14,6 +14,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: setuptools>=75.1.0
 Requires-Dist: googleapis-common-protos>=1.56.4
 Requires-Dist: google-auth>=2.11.0
 Requires-Dist: google-cloud-pubsub==2.13.6
@@ -66,7 +67,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.
 ###################################################################
@@ -146,7 +153,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-2.2.1.dev1 → dnastreaming-2.3.0}/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-2.3.0/dnaStreaming/__init__.py

@@ -0,0 +1,45 @@
+from __future__ import absolute_import, division, print_function
+
+import os
+import sys
+import logging
+
+
+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()
+
+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)
+
+consoleHandler = logging.StreamHandler(sys.stdout)
+consoleHandler.setFormatter(logFormatter)
+logger.addHandler(consoleHandler)

{dnastreaming-2.2.1.dev1 → dnastreaming-2.3.0/dnaStreaming.egg-info}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: dnaStreaming
-Version: 2.2.1.dev1
+Version: 2.3.0
 Summary: Dow Jones DNA Streaming Project
 Home-page: https://github.com/dowjones/dj-dna-streams-python
-Download-URL: https://github.com/dowjones/dj-dna-streams-python/archive/release-2.2.1.dev1.tar.gz
+Download-URL: https://github.com/dowjones/dj-dna-streams-python/archive/release-2.3.0.tar.gz
 Author: Zachary Kagan
 Author-email: zachary.kagan@dowjones.com
 License: MIT
@@ -14,6 +14,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: setuptools>=75.1.0
 Requires-Dist: googleapis-common-protos>=1.56.4
 Requires-Dist: google-auth>=2.11.0
 Requires-Dist: google-cloud-pubsub==2.13.6
@@ -66,7 +67,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.
 ###################################################################
@@ -146,7 +153,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-2.2.1.dev1 → dnastreaming-2.3.0}/dnaStreaming.egg-info/requires.txt

@@ -1,3 +1,4 @@
+setuptools>=75.1.0
 googleapis-common-protos>=1.56.4
 google-auth>=2.11.0
 google-cloud-pubsub==2.13.6

{dnastreaming-2.2.1.dev1 → dnastreaming-2.3.0}/setup.py

@@ -6,7 +6,7 @@ this_directory = path.abspath(path.dirname(__file__))
 with open(path.join(this_directory, 'README.rst'), encoding='utf-8') as f:
     long_description = f.read()
 
-VERSION = "2.2.1.dev1"
+VERSION = "2.3.0"
 RELEASE_TAG = f"release-{VERSION}"
 
 setup(
@@ -28,6 +28,7 @@ setup(
     include_package_data=True,
 
     install_requires=[
+        'setuptools>=75.1.0',
         'googleapis-common-protos>=1.56.4',
         'google-auth>=2.11.0',
         'google-cloud-pubsub==2.13.6',

dnastreaming-2.2.1.dev1/dnaStreaming/__init__.py

@@ -1,29 +0,0 @@
-from __future__ import absolute_import, division, print_function
-
-import os
-import sys
-import logging
-
-
-BASE_DIR = os.path.dirname(__file__)
-
-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'))
-
-logFormatter = logging.Formatter("%(asctime)s [%(threadName)-12.12s] [%(levelname)-5.5s]  %(message)s")
-fileHandler.setFormatter(logFormatter)
-logger.addHandler(fileHandler)
-
-consoleHandler = logging.StreamHandler(sys.stdout)
-consoleHandler.setFormatter(logFormatter)
-logger.addHandler(consoleHandler)