Changeset b00fbbb in ammosreader

Timestamp:

05/19/23 12:33:29 (2 years ago)

Author:

Enrico Schwass <ennoausberlin@…>

Branches:

AmmosSource, guix

Children:

efb5900

Parents:

dff8988

Message:

README.org updated

Files:

• ammosreader/__init__.py (modified) (2 diffs)
• org/README.org (modified) (3 diffs)

ammosreader/__init__.py

@@ -4 +4 @@
 from pathlib import Path
 
-# change the default log path to /var/log/ammos/ammos.log when system configuration created this dir
+# FIXME: change the default log path to /var/log/ammos/ammos.log when system configuration created this dir
 # with the appropriate rights
 
@@ -12 +12 @@
 
 if not log_path.exists():
-#   print(log_path, "does not exist")
     try:
-#       print("Trying to create logfile", str(log_path))
         log_path.touch()
     except PermissionError:
-#       print("Logging to file disabled")
         conf_file = Path(__file__).parent / 'ammos_logging.conf'
         print("Conf file", conf_file)
         logging.config.fileConfig(conf_file)
 else:
-#   print("Logging to", str(log_path))
     logging.basicConfig(filename=str(log_path), encoding='utf-8', level=logging.DEBUG)
 
 logger = logging.getLogger(__name__)
-
-logger.warning("Text")

org/README.org

@@ -7 +7 @@
 * Installation
 
+** Standard pip install (not tested on all platforms)
+
 #+BEGIN_SRC shell
 git clone http://gitlab.kid.local/kidzg/ammosreader.git
@@ -13 +15 @@
 #+END_SRC
 
+** Using the guix functional package manager
+
+First subscribe to the GUIX oai channel (see Chapter Add channel to system) in
+https://gitlab.kid.local/kidzg/guix-deployment/-/blob/master/DevOps.org)
+
+Then install using the guix
+
+#+BEGIN_SRC shell
+guix package -i python-ammosreader
+#+END_SRC
+
 * Usage
 
-The sample_scripts subdirectory contains multiple scripts.
-
-** audio_reader.py
-
-#+BEGIN_SRC shell
-python3 audio_reader.py 'path_to_ammos_file'
-#+END_SRC
+There are two scripts, which demonstrate the usage of the ammosreader package.
 
 ** iqdw_reader.py
@@ -34 +41 @@
 python3 pdw_reader.py 'path_to_pdw_file'
 #+END_SRC
+
+To minimize depencencies of the core package other scripts (audio_reader, ammos_viewer)
+are now stored in separate packages. 
+
+* Logging
+
+If you use ammosreader in your own scripts a logger can be imported and used as follows:
+
+#+BEGIN_SRC python
+from ammosreader import logger
+logger.warning("Put your warning here")
+#+END_SRC
+
+The name of the logfile is ammos.log
+The logger uses the directory stored in the AMMOS_LOG_DIR environment variable.
+If this variable is not set, /tmp is used as default.
+If the logfile is not writable, the standard logger config is used and
+the logs go directly to console (tty).
+(see ammos_logging.conf file in this repository)