add non-critical key NT version 2, issue #16

* rename CLI binary to lowercase version
* IMCtermite.pyx: rename boolean data flag
* insert some double quotes in sampleA.raw for testing
* version 2.0.1

.github/workflows/pypi-deploy.yml

@@ -3,7 +3,8 @@ name: Build Python Wheels
 
 on:
   push:
-    branches: [master]
+    #branches: [master]
+    tags: ["v[0-9]+.[0-9]+.[0-9]+"]
 
 jobs:
 
@@ -44,6 +45,11 @@ jobs:
         working-directory: python/
         # env:
         #   CIBW_BUILD: cp36-* cp37-* cp38-* cp39-* cp310-*
+      - name: Store binary wheels
+        uses: actions/upload-artifact@v2
+        with:
+          name: binary-wheels
+          path: python/wheelhouse/*.whl
 
   build_sdist:
     name: Build source distribution
@@ -61,6 +67,12 @@ jobs:
       - name: Build sdist
         run: python setup.py sdist
         working-directory: python/
+      - name: Store source wheels
+        uses: actions/upload-artifact@v2
+        with:
+          name: source-wheels
+          path: python/dist/*.tar.gz
+
 
   upload_pypi:
     name: Upload binary wheels to PyPI
@@ -68,6 +80,17 @@ jobs:
     needs: [build_wheels, build_sdist]
 
     steps:
+      - name: Get source wheels
+        uses: actions/download-artifact@v2
+        with:
+          name: source-wheels
+          path: dist/
+      - name: Get binary wheels
+        uses: actions/download-artifact@v2
+        with:
+          name: binary-wheels
+          path: dist/
+
       - uses: pypa/gh-action-pypi-publish@release/v1
         with:
           user: __token__

README.md

@@ -31,6 +31,8 @@ On the [Record Evolution Platform](https://www.record-evolution.de/en/home-en/),
 
 ## File format
 
+[Warning: Take a look at [this issue](https://github.com/RecordEvolution/IMCtermite/issues/14) when reading this section regarding the file format.]
+
 A data file of the _IMC Bus Format_ type with the extension _.raw_ is a _mixed text/binary
 file_ featuring a set of markers (keys) that indicate the start of various blocks
 of data that provide meta information and the actual measurement data. Every single
@@ -150,8 +152,11 @@ To install the latest version simply do
 python3 -m pip install IMCtermite
 ```
 
-Note, that _python3_setuptools_ and _gcc version >= 10.2.0_ are required to
+which provides binary wheels for multiple architectures on _Windows_ and _Linux_
-successfully install and use it.
+and most _Python 3.x_ distributions. However, if your platform/architecture is
+not supported you can still compile the source distribution yourself, which
+requires _python3_setuptools_ and an up-to-date compiler supporting C++11
+standard (e.g. _gcc version >= 10.2.0_).
 
 ## Usage
 
@@ -187,23 +192,23 @@ options `imctermite sample-data.raw -b -c -s '|'`.
 
 ### Python
 
-Given the `imctermite` module is available, we can import it and declare an instance
+Given the `IMCtermite` module is available, we can import it and declare an instance
 of it by passing a _raw_ file to the constructor:
 
 ```Python
-import imc_termite
+import IMCtermite
 
-imcraw = imc_termite.imctermite(b"sample/sampleA.raw")
+imcraw = IMCtermite.imctermite(b"sample/sampleA.raw")
 ```
 
 An example of how to create an instance and obtain the list of channels is:
 
 ```Python
-import imc_termite
+import IMCtermite
 
 # declare and initialize instance of "imctermite" by passing a raw-file
 try :
-    imcraw = imc_termite.imctermite(b"samples/sampleA.raw")
+    imcraw = IMCtermite.imctermite(b"samples/sampleA.raw")
 except RuntimeError as e :
     print("failed to load/parse raw-file: " + str(e))
 

lib/imc_channel.hpp

@@ -455,12 +455,12 @@ namespace imc
              <<"\",\"trigger-time\":\""<<std::put_time(std::localtime(&att),"%FT%T")
              <<"\",\"language-code\":\""<<language_code_
              <<"\",\"codepage\":\""<<codepage_
-             <<"\",\"yname\":\""<<yname_
+             <<"\",\"yname\":\""<<prepjsonstr(yname_)
-             <<"\",\"yunit\":\""<<yunit_
+             <<"\",\"yunit\":\""<<prepjsonstr(yunit_)
              <<"\",\"significantbits\":\""<<signbits_
              <<"\",\"addtime\":\""<<addtime_
-             <<"\",\"xname\":\""<<xname_
+             <<"\",\"xname\":\""<<prepjsonstr(xname_)
-             <<"\",\"xunit\":\""<<xunit_
+             <<"\",\"xunit\":\""<<prepjsonstr(xunit_)
              <<"\",\"xstepwidth\":\""<<xstepwidth_
              <<"\",\"xoffset\":\""<<xoffset_
              <<"\",\"group\":{"<<"\"index\":\""<<group_index_
@@ -477,6 +477,25 @@ namespace imc
       return ss.str();
     }
 
+    // prepare string value for usage in JSON dump
+    std::string prepjsonstr(std::string value)
+    {
+      std::stringstream ss;
+      ss<<quoted(value);
+      return strip_quotes(ss.str());
+    }
+
+    // remove any leading or trailing double quotes
+    std::string strip_quotes(std::string astring)
+    {
+      // head
+      if ( astring.front() == '"' ) astring.erase(astring.begin()+0);
+      // tail
+      if ( astring.back() == '"' ) astring.erase(astring.end()-1);
+
+      return astring;
+    }
+
     // print channel
     void print(std::string filename, const char sep = ',', int width = 25, int yprec = 9)
     {

lib/imc_key.hpp

@@ -84,6 +84,7 @@ namespace imc
     // noncritical keys
     key(false,"NO","origin of data",1),
     key(false,"NT","timestamp of trigger",1),
+    key(false,"NT","timestamp of trigger",2),
     key(false,"ND","(color) display properties",1),
     key(false,"NU","user defined key",1),
     key(false,"Np","property of channel",1),

makefile

@@ -3,7 +3,7 @@
 SHELL := /bin/bash
 
 # name of executable and CLI tool
-EXE = IMCtermite
+EXE = imctermite
 
 # directory names
 SRC = src/
@@ -31,7 +31,7 @@ INST := /usr/local/bin
 #-----------------------------------------------------------------------------#
 # C++ and CLI tool
 
-# build exectuable
+# build executable
 $(EXE): check-tags $(GVSN) main.o
 	$(CC) $(OPT) main.o -o $@
 

python/IMCtermite.pyx

@@ -20,8 +20,8 @@ cdef class imctermite:
     self.cppimc.set_file(rawfile)
 
   # get JSON list of channels
-  def get_channels(self, bool data):
+  def get_channels(self, bool include_data):
-    chnlst = self.cppimc.get_channels(True,data)
+    chnlst = self.cppimc.get_channels(True,include_data)
     chnlstjn = [jn.loads(chn.decode(errors="ignore")) for chn in chnlst]
     return chnlstjn
 

python/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.3