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/setup.sh

@@ -1,5 +0,0 @@
-#!/bin/bash
-
-cat ../README.md | grep '^# IMCtermite' -A 50000 > ../python/README.md
-cp -r ../lib ../python/
-cp -v ../LICENSE ../python/

.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:
 
@@ -11,10 +12,14 @@ jobs:
     name: Prepare environment for wheel builds
     runs-on: ubuntu-20.04
     steps:
-      - name: Prepare files
-        run: |
-          chmod +x "${GITHUB_WORKSPACE}/.github/setup.sh"
-          "${GITHUB_WORKSPACE}/.github/setup.sh"
+      - uses: actions/checkout@v2
+      - name: Prepare wheel build
+        run: make -C python/ setup
+      - name: Store wheel configuration files
+        uses: actions/upload-artifact@v2
+        with:
+          name: wheel-config
+          path: python/
 
   build_wheels:
     name: Build binary wheels on ${{ matrix.os }}
@@ -22,20 +27,29 @@ jobs:
     needs: [build_setup]
     strategy:
       matrix:
-        os: [ubuntu-20.04, windows-2019, macOS-10.15]
-        arch: [auto32, auto64, aarch64, ppc64le, s390x]
+        os: [ubuntu-20.04, windows-2019]
+        arch: [auto32, auto64, aarch64]
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
       - name: Install cibuildwheel
         run: python -m pip install cibuildwheel==2.1.2
-        working-directory: python/
+      - name: Get wheel configuration files
+        uses: actions/download-artifact@v2
+        with:
+          name: wheel-config
+          path: python/
       - name: Build wheels
         run: python -m cibuildwheel --output-dir wheelhouse
         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
@@ -45,9 +59,20 @@ jobs:
       - uses: actions/checkout@v2
       - name: Install cython
         run: python -m pip install cython==0.29.24
+      - name: Get wheel configuration files
+        uses: actions/download-artifact@v2
+        with:
+          name: wheel-config
+          path: python/
       - 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
@@ -55,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__

.gitignore

@@ -34,6 +34,7 @@ pip/dist/
 pip/build/
 
 python/README.md
+python/README.rst
 python/LICENSE
 python/build
 python/*.egg-info

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
-successfully install and use it.
+which provides binary wheels for multiple architectures on _Windows_ and _Linux_
+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_
-             <<"\",\"yunit\":\""<<yunit_
+             <<"\",\"yname\":\""<<prepjsonstr(yname_)
+             <<"\",\"yunit\":\""<<prepjsonstr(yunit_)
              <<"\",\"significantbits\":\""<<signbits_
              <<"\",\"addtime\":\""<<addtime_
-             <<"\",\"xname\":\""<<xname_
-             <<"\",\"xunit\":\""<<xunit_
+             <<"\",\"xname\":\""<<prepjsonstr(xname_)
+             <<"\",\"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 $@
 
@@ -91,6 +91,9 @@ python-clean:
 	make -C python/ clean
 	rm -vf IMCtermite*.so
 
+python-test:
+	PYTHONPATH=./ python python/examples/usage.py
+
 #-----------------------------------------------------------------------------#
 # clean
 

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):
-    chnlst = self.cppimc.get_channels(True,data)
+  def get_channels(self, bool include_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

python/examples/usage.py

@@ -21,18 +21,18 @@ if len(channelsdata) > 0 :
 
 print(len(chnydata))
 print(len(chnxdata))
+print()
 
 # print the channels into a specific directory
-imcraw.print_channels(b"./data",ord(','))
+imcraw.print_channels(b"/tmp/",ord(','))
 
 # print all channels separately
-idx = 0
-for chn in channels :
-    print(str(idx)+" : "+chn['name']+" : "+chn['uuid'])
-    filname = os.path.join("./data",str(idx) + "_" + chn['name']+".csv")
+for i,chn in enumerate(channels) :
+    print(str(i)+" : "+chn['name']+" : "+chn['uuid'])
+    filname = os.path.join("/tmp/",str(i) + "_" + chn['name']+".csv")
     print(filname)
     imcraw.print_channel(chn['uuid'].encode(),filname.encode(),ord(','))
-    idx = idx + 1
 
 # print all channels in single file
-# imcraw.print_table(b"./data/allchannels.csv")
+imcraw.print_table(b"/tmp/allchannels.csv")
+

python/makefile

@@ -1,11 +1,13 @@
 
 setup:
 	cat ../README.md | grep '^# IMCtermite' -A 50000 > ./README.md
+	#pandoc -f markdown -t rst -o README.rst README.md
+	#python -m rstvalidator README.rst
 	cp -r ../lib ./
 	cp -v ../LICENSE ./
 
 setup-clean:
-	rm -vf README.md LICENSE
+	rm -vf README.md README.rst LICENSE
 	rm -rf lib/
 
 build: setup
@@ -16,9 +18,11 @@ build-inplace: setup
 
 build-sdist: setup
 	python setup.py sdist
+	python -m twine check dist/*
 
 build-bdist: setup
 	python setup.py bdist
+	python -m twine check dist/*
 
 build-clean:
 	python setup.py clean --all

python/setup.cfg

@@ -1,8 +1,10 @@
 
 [metadata]
 name = IMCtermite
-description = Enables extraction of measurement data from binary files with extension 'raw' used by proprietary software imcFAMOS/imcSTUDIO and facilitates its storage in open source file formats
+description = Enables extraction of measurement data from binary files with extension 'raw' used by proprietary software imcFAMOS and imcSTUDIO and facilitates its storage in open source file formats
 long_description = file: README.md
+# long_description_content_type = text/x-rst
+long_description_content_type = text/markdown
 version = file: VERSION
 author = Record Evolution GmbH
 author_email = mario.fink@record-evolution.de
@@ -12,8 +14,8 @@ license = MIT License
 license_files = LICENSE
 keywords = IMC, raw, imcFAMOS, imcSTUDIO, imcCRONOS
 classifiers =
-  Programming Language :: Python :: 3,
-  License :: OSI Approved :: MIT License,
+  Programming Language :: Python :: 3
+  License :: OSI Approved :: MIT License
   Operating System :: OS Independent
   Topic :: Scientific/Engineering
   Topic :: Software Development :: Libraries :: Python Modules

python/setup.py

@@ -1,6 +1,5 @@
 from setuptools import Extension, setup
 from Cython.Build import cythonize
-import os
 import sys
 
 print("building on platform: "+sys.platform)