DataGen¶

You have 2 options how to install DataGen extension.

Package¶

Install it via Python package managers PIP or easy_install.

$ sudo pip install --no-binary :all: hydratk-ext-datagen
$ sudo easy_install hydratk-ext-datagen
Note

PIP needs option –no-binary to run setup.py install. Otherwise it runs setup.py bdist_wheel.

Source¶

Download the source code from GitHub or PyPi and install it manually. Full PyPi URL contains MD5 hash, adapt sample code.

$ git clone https://github.com/hydratk/hydratk-ext-datagen.git
$ cd ./hydratk-ext-datagen
$ sudo python setup.py install
$ wget https://python.org/pypi/hydratk-ext-datagen -O hydratk-ext-datagen.tar.gz
$ tar -xf hydratk-ext-datagen.tar.gz
$ cd ./hydratk-ext-datagen
$ sudo python setup.py install
Note

Source is distributed with Sphinx (not installed automatically) documentation in directory doc. Type make html to build local documentation however is it recommended to use up to date online documentation.

Requirements¶

The extension requires hydratk, hydratk-lib-network.

Note

ASN.1 codec uses external tool ffasn1dump created by Fabrice Bellard. The tool must be downloaded and installed manually.

Installation¶

See installation example, Python 2.7.

**************************************
*     Running pre-install tasks      *
**************************************

*** Running task: version_update ***

*** Running task: install_modules ***
Module hydratk already installed with version 0.5.0rc1
Module hydratk-lib-network already installed with version 0.2.1rc1

running install
running bdist_egg
running egg_info
creating src/hydratk_ext_datagen.egg-info
writing src/hydratk_ext_datagen.egg-info/PKG-INFO
writing top-level names to src/hydratk_ext_datagen.egg-info/top_level.txt
writing dependency_links to src/hydratk_ext_datagen.egg-info/dependency_links.txt
writing entry points to src/hydratk_ext_datagen.egg-info/entry_points.txt
writing manifest file 'src/hydratk_ext_datagen.egg-info/SOURCES.txt'
reading manifest file 'src/hydratk_ext_datagen.egg-info/SOURCES.txt'
reading manifest template 'MANIFEST.in'
writing manifest file 'src/hydratk_ext_datagen.egg-info/SOURCES.txt'
installing library code to build/bdist.linux-x86_64/egg
running install_lib
running build_py
creating build
creating build/lib.linux-x86_64-2.7
creating build/lib.linux-x86_64-2.7/hydratk
...
creating build/bdist.linux-x86_64/egg/EGG-INFO
copying src/hydratk_ext_datagen.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFO
copying src/hydratk_ext_datagen.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying src/hydratk_ext_datagen.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying src/hydratk_ext_datagen.egg-info/entry_points.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
copying src/hydratk_ext_datagen.egg-info/not-zip-safe -> build/bdist.linux-x86_64/egg/EGG-INFO
copying src/hydratk_ext_datagen.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFO
creating dist
creating 'dist/hydratk_ext_datagen-0.1.2rc1-py2.7.egg' and adding 'build/bdist.linux-x86_64/egg' to it
removing 'build/bdist.linux-x86_64/egg' (and everything under it)
Processing hydratk_ext_datagen-0.1.2rc1-py2.7.egg
creating /usr/local/lib/python2.7/dist-packages/hydratk_ext_datagen-0.1.2rc1-py2.7.egg
Extracting hydratk_ext_datagen-0.1.2rc1-py2.7.egg to /usr/local/lib/python2.7/dist-packages
Adding hydratk-ext-datagen 0.1.2rc1 to easy-install.pth file
Installing datagen script to /usr/local/bin
Installed /usr/local/lib/python2.7/dist-packages/hydratk_ext_datagen-0.1.2rc1-py2.7.egg
Processing dependencies for hydratk-ext-datagen==0.1.2rc1
Finished processing dependencies for hydratk-ext-datagen==0.1.2rc1

**************************************
*     Running post-install tasks     *
**************************************

*** Running task: set_config ***

Copying file etc/hydratk/conf.d/hydratk-ext-datagen.conf to /etc/hydratk/conf.d

*** Running task: set_manpage ***

Application installs following (paths depend on your OS configuration)

datagen command in /usr/local/bin/datagen
modules in /usr/local/lib/python2.7/dist-packages/hydratk_ext_datagen-0.1.2-py2.7.egg
configuration file in /etc/hydratk/conf.d/hydratk-ext-datagen.conf

Run¶

When installation is finished you can run the application.

Check hydratk-ext-datagen module is installed.

$ pip list | grep hydratk-ext-datagen

hydratk-ext-datagen (0.1.2)

Check installed extensions

$ htk list-extensions

DataGen: DataGen v0.1.3 (c) [2016 - 2017 Petr Rašek <bowman@hydratk.org>, HydraTK team <team@hydratk.org>]

Type command htk help and detailed info is displayed. Type man datagen to display manual page.

$ htk help

Commands:
   gen-asn1 - encode text file, decode binary file according to ASN.1 specification
      Options:
         --gen-action compile|decode|encode|transcode - action
         --gen-element <title> - element title from specification
         --gen-input <path> - input filename
         --gen-spec <path> - specification filename
        [--gen-iformat ber|der|oer|aper|uper|xer|gser] - input format, default ber for action decode, gser for action encode
        [--gen-oformat ber|der|oer|aper|uper|xer|gser] - output format, default ber for action encode, gser for action decode
        [--gen-output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml

   gen-json - generate sample json file according to JSON specification
      Options:
         --gen-spec <path> - specification filename
        [--gen-output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml

   gen-selenium - adapt Selenium script to Yoda format
      Options:
         --gen-input <path> - input filename
         [--gen-browser <title>] - browser to be used, default Firefox
         [--gen-output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml
         [--gen-timeout <number>] - timeout for wait commands, default 10

   gen-xml - generate sample xml file according to WSDL/XSD specification
      Options:
         --gen-element <title> - element title from specification
         --gen-spec <path> - specification filename
        [--gen-envelope] - generate including SOAP envelope
        [--gen-output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml

You can run DataGen also in standalone mode.

$ datagen help

DataGen v0.1.1
(c) 2016 Petr Rašek <bowman@hydratk.org>, HydraTK team <team@hydratk.org>
Usage: datagen [options] command

Commands:
   asn1 - encode text file, decode binary file according to ASN.1 specification
      Options:
         --action compile|decode|encode|transcode - action
         --element <title> - element title from specification
         --input <path> - input filename
         --spec <path> - specification filename
         [--iformat ber|der|oer|aper|uper|xer|gser] - input format, default ber for action decode, gser for action encode
         [--oformat ber|der|oer|aper|uper|xer|gser] - output format, default ber for action encode, gser for action decode
         [--output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml

   help - prints help
   json - generate sample json file according to JSON specification
      Options:
         --spec <path> - specification filename
         [--output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml

   selenium - adapt Selenium script to Yoda format
      Options:
         --input <path> - input filename
         [--browser <title>] - browser to be used, default Firefox
         [--output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml
         [--timeout <number>] - timeout for wait commands, default 10

   xml - generate sample xml file according to WSDL/XSD specification
      Options:
         --element <title> - element title from specification
         --spec <path> - specification filename
         [--envelope] - generate including SOAP envelope
         [--output <path>] - output filename, default input filename with changed suffix or sample.json, sample.xml

Global Options:
   -c, --config <file> - reads the alternate configuration file
   -d, --debug <level> - debug turned on with specified level > 0
   -e, --debug-channel <channel number, ..> - debug channel filter turned on
   -f, --force - enforces command
   -h, --home - sets htk_root_dir to the current user home directory
   -i, --interactive - turns on interactive mode
   -l, --language <language> - sets the text output language, the list of available languages is specified in the docs
   -m, --run-mode <mode> - sets the running mode, the list of available modes is specified in the docs

Upgrade¶

Use same procedure as for installation. Use command option –upgrade for pip, easy_install, –force for setup.py. If configuration file differs from default settings the file is backuped (extension _old) and replaced by default. Adapt the configuration if needed.

Uninstall¶

Run command htkuninstall datagen Use option -y if you want to uninstall also dependent Python modules (for advanced user).