.. install_ext_trackapps: TrackApps ========= You have 2 options how to install TrackApps extension. Package ^^^^^^^ Install it via Python package managers PIP or easy_install. .. code-block:: bash $ sudo pip install --no-binary :all: hydratk-ext-trackapps .. code-block:: bash $ sudo easy_install hydratk-ext-trackapps .. 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. .. code-block:: bash $ git clone https://github.com/hydratk/hydratk-ext-trackapps.git $ cd ./hydratk-ext-trackapps $ sudo python setup.py install .. code-block:: bash $ wget https://python.org/pypi/hydratk-ext-trackapps -O hydratk-ext-trackapps.tar.gz $ tar -xf hydratk-ext-trackapps.tar.gz $ cd ./hydratk-ext-trackapps $ 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. Installation ^^^^^^^^^^^^ See installation example, Python 2.7. .. code-block:: bash ************************************** * Running pre-install tasks * ************************************** *** 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_trackapps.egg-info writing src/hydratk_ext_trackapps.egg-info/PKG-INFO writing top-level names to src/hydratk_ext_trackapps.egg-info/top_level.txt writing dependency_links to src/hydratk_ext_trackapps.egg-info/dependency_links.txt writing entry points to src/hydratk_ext_trackapps.egg-info/entry_points.txt writing manifest file 'src/hydratk_ext_trackapps.egg-info/SOURCES.txt' reading manifest file 'src/hydratk_ext_trackapps.egg-info/SOURCES.txt' reading manifest template 'MANIFEST.in' writing manifest file 'src/hydratk_ext_trackapps.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_trackapps.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/hydratk_ext_trackapps.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/hydratk_ext_trackapps.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/hydratk_ext_trackapps.egg-info/entry_points.txt -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/hydratk_ext_trackapps.egg-info/not-zip-safe -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/hydratk_ext_trackapps.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFO creating dist creating 'dist/hydratk_ext_trackapps-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_trackapps-0.1.2rc1-py2.7.egg creating /usr/local/lib/python2.7/dist-packages/hydratk_ext_trackapps-0.1.2rc1-py2.7.egg Extracting hydratk_ext_trackapps-0.1.2rc1-py2.7.egg to /usr/local/lib/python2.7/dist-packages Adding hydratk-ext-trackapps 0.1.2rc1 to easy-install.pth file Installing trackapps script to /usr/local/bin Installed /usr/local/lib/python2.7/dist-packages/hydratk_ext_trackapps-0.1.2rc1-py2.7.egg Processing dependencies for hydratk-ext-trackapps==0.1.2rc1 Finished processing dependencies for hydratk-ext-trackapps==0.1.2rc1 ************************************** * Running post-install tasks * ************************************** *** Running task: set_config *** Copying file etc/hydratk/conf.d/hydratk-ext-trackapps.conf to /etc/hydratk/conf.d *** Running task: set_manpage *** Application installs following (paths depend on your OS configuration) * trackapps command in /usr/local/bin/trackapps * modules in /usr/local/lib/python2.7/dist-packages/hydratk_ext_trackapps-0.1.2-py2.7.egg * configuration file in /etc/hydratk/conf.d/hydratk-ext-trackapps.conf Run ^^^ When installation is finished you can run the application. Check hydratk-ext-trackapps module is installed. .. code-block:: bash $ pip list | grep hydratk-ext-trackapps hydratk-ext-trackapps (0.1.2) Check installed extensions .. code-block:: bash $ htk list-extensions TrackApps: TrackApps v0.1.2 (c) [2016 - 2017 Petr Rašek , HydraTK team ] Type command htk help and detailed info is displayed. Type man trackapps to display manual page. .. code-block:: bash $ htk help Commands: track - run trackapps command line extension Options: [--tr-dev-key ] - developer key, configurable, supported for app: testlink [--tr-domain ] - domain, configurable, supported for app: qc [--tr-fields ] - requested fields, name1,name2,... , supported for action: read [--tr-id ] - record id, supported for actions: read|update|delete [--tr-input ] - filename, content is written to ticket description, supported for actions: create|update [--tr-limit ] - limit, supported for action: read, apps: qc|bugzilla|jira [--tr-offset ] - offset, supported for action: read, apps: qc|bugzilla|jira [--tr-order-by ] - record ordering, name1:direction,name2:direction,... , direction asc|desc, supported for action: read, app: qc [--tr-output ] - filename, writes action output, supported for action: read [--tr-page ] - record page, supported for action: read, app: mantis [--tr-params ] - record parameters, name1:value,name2:value,... , supported for actions: create|update [--tr-passw ] - password, configurable [--tr-path ] - directory path, dir1/dir2/... , supported for use cases: read/create folder|read/create test set|create test|read/create suite, apps: qc|testlink [--tr-per-page ] - records per page, supported for action: read, app: mantis [--tr-project ] - project, configurable, supported for apps: qc|mantis|trac|jira|testlink [--tr-query ] - query, supported for action: read, apps: qc|bugzilla|trac|jira [--tr-steps ] - test steps delimited by |, step parameters use dictionary form, name1:value,name2:value,...|name1:value,name2:value,... , supported for action: create, app: testlink [--tr-type defect|test-folder|test|test-set-folder|test-set|test-instance|test-suite|test-plan|build] - entity type, default defect, supported for actions: read|create|update|delete, apps: qc|testlink [--tr-url ] - url, configurable [--tr-user ] - username, configurable --tr-action read|create|update|delete - action, delete supported for apps: qc|mantis|trac --tr-app qc|bugzilla|mantis|trac|testlink - application You can run TrackApps also in standalone mode. .. code-block:: bash $ trackapps help TrackApps v0.1.1 (c) 2016 Petr Rašek , HydraTK team Usage: trackapps [options] command Commands: help - prints help run - run trackapps command line extension Options: [--dev-key ] - developer key, configurable, supported for app: testlink [--domain ] - domain, configurable, supported for app: qc [--fields ] - requested fields, name1,name2,... , supported for action: read [--id ] - record id, supported for actions: read|update|delete [--input ] - filename, content is written to ticket description, supported for actions: create|update [--limit ] - limit, supported for action: read, apps: qc|bugzilla|jira [--offset ] - offset, supported for action: read, apps: qc|bugzilla|jira [--order-by ] - record ordering, name1:direction,name2:direction,... , direction asc|desc, supported for action: read, app: qc [--output ] - filename, writes action output, supported for action: read [--page ] - record page, supported for action: read, app: mantis [--params ] - record parameters, name1:value,name2:value,... , supported for actions: create|update [--passw ] - password, configurable [--path ] - directory path, dir1/dir2/... , supported for use cases: read/create folder|read/create test set|create test|read/create suite, apps: qc|testlink [--per-page ] - records per page, supported for action: read, app: mantis [--project ] - project, configurable, supported for apps: qc|mantis|trac|jira|testlink [--query ] - query, supported for action: read, apps: qc|bugzilla|trac|jira [--steps ] - test steps delimited by |, step parameters use dictionary form, name1:value,name2:value,...|name1:value,name2:value,... , supported for action: create, app: testlink [--type defect|test-folder|test|test-set-folder|test-set|test-instance|test-suite|test-plan|build] - entity type, default defect, supported for actions: read|create|update|delete, apps: qc|testlink [--url ] - url, configurable [--user ] - username, configurable --action read|create|update|delete - action, delete supported for apps: qc|mantis|trac --app qc|bugzilla|mantis|trac|testlink - application Global Options: -c, --config - reads the alternate configuration file -d, --debug - debug turned on with specified level > 0 -e, --debug-channel - 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 - sets the text output language, the list of available languages is specified in the docs -m, --run-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. Use option -y if you want to uninstall also dependent Python modules (for advanced user).