source: ammosreader/org/README.org@ b00fbbb

#+OPTIONS: ^:nil

* AmmosReader

Project containing necessary File- or SocketStream-Reader to read the various datastreams of Ammos

* Installation

** Standard pip install (not tested on all platforms)

#+BEGIN_SRC shell
git clone http://gitlab.kid.local/kidzg/ammosreader.git
cd ammosreader
python3 -m pip install .
#+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

There are two scripts, which demonstrate the usage of the ammosreader package.

** iqdw_reader.py

#+BEGIN_SRC shell
python3 iqdw_reader.py 'path_to_iqdw_file'
#+END_SRC

** pdw_reader.py

#+BEGIN_SRC shell
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)