robotframework-robotlog2rqm 1.2.0__tar.gz → 1.2.3__tar.gz

{robotframework-robotlog2rqm-1.2.0 → robotframework-robotlog2rqm-1.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: robotframework-robotlog2rqm
-Version: 1.2.0
+Version: 1.2.3
 Summary: Imports robot result(s) to IBM Rational Quality Manager (RQM)
 Home-page: https://github.com/test-fullautomation/robotframework-robotlog2rqm
 Author: Tran Duy Ngoan
@@ -49,24 +49,63 @@ How to install
     pip install RobotLog2RQM
     ```
 
-    [RobotLog2RQM in PyPi](https://pypi.org/project/RobotLog2RQM/)
+    [RobotLog2RQM in
+    PyPi](https://pypi.org/project/robotframework-robotlog2rqm/)
 
 2.  Installation via GitHub (recommended for developers)
 
-    Clone the **python-robotlog2rqm** repository to your machine.
+    -   Clone the **robotframework-robotlog2rqm** repository to your
+        machine.
 
-    ``` {.}
-    git clone https://github.com/test-fullautomation/python-robotlog2rqm.git
-    ```
+        ``` {.}
+        git clone https://github.com/test-fullautomation/robotframework-robotlog2rqm.git
+        ```
 
-    [RobotLog2RQM in
-    GitHub](https://github.com/test-fullautomation/python-robotlog2rqm)
+        [RobotLog2RQM in
+        GitHub](https://github.com/test-fullautomation/robotframework-robotlog2rqm)
 
-    Use the following command to install **RobotLog2RQM**:
+    -   Install dependencies
 
-    ``` {.}
-    setup.py install
-    ```
+        **RobotLog2RQM** requires some additional Python libraries.
+        Before you install the cloned repository sources you have to
+        install the dependencies manually. The names of all related
+        packages you can find in the file `requirements.txt` in the
+        repository root folder. Use pip to install them:
+
+        ``` {.}
+        pip install -r ./requirements.txt
+        ```
+
+        Additionally install **LaTeX** (recommended: TeX Live). This is
+        used to render the documentation.
+
+    -   Configure dependencies
+
+        The installation of **RobotLog2RQM** includes to generate the
+        documentation in PDF format. This is done by an application
+        called **GenPackageDoc**, that is part of the installation
+        dependencies (see `requirements.txt`).
+
+        **GenPackageDoc** uses **LaTeX** to generate the documentation
+        in PDF format. Therefore **GenPackageDoc** needs to know where
+        to find **LaTeX**. This is defined in the **GenPackageDoc**
+        configuration file
+
+        ``` {.}
+        packagedoc\packagedoc_config.json
+        ```
+
+        Before you start the installation you have to introduce the
+        following environment variable, that is used in
+        `packagedoc_config.json`:
+
+        -   `GENDOC_LATEXPATH` : path to `pdflatex` executable
+
+    -   Use the following command to install **RobotLog2RQM**:
+
+        ``` {.}
+        python setup.py install
+        ```
 
 After succesful installation, the executable file **RobotLog2RQM** will
 be available (under *Scripts* folder of Python on Windows and
@@ -89,15 +128,15 @@ Use below command to get tools\'s usage:
 
 The usage should be showed as below:
 
-    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive] 
-                        [--createmissing] [--updatetestcase] [--dryrun] 
+    usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive]
+                        [--createmissing] [--updatetestcase] [--dryrun]
                         resultxmlfile host project user password testplan
 
-    RobotLog2RQM imports XML result files (default: output.xml) generated by the 
+    RobotLog2RQM imports XML result files (default: output.xml) generated by the
     Robot Framework into an IBM Rational Quality Manager.
 
     positional arguments:
-    resultxmlfile     absolute or relative path to the xml result file 
+    resultxmlfile     absolute or relative path to the xml result file
                       or directory of result files to be imported.
     host              RQM host url.
     project           project on RQM.
@@ -108,13 +147,13 @@ The usage should be showed as below:
     optional arguments:
     -h, --help        show this help message and exit
     -v, --version     Version of the RobotLog2RQM importer.
-    --recursive       if set, then the path is searched recursively for 
+    --recursive       if set, then the path is searched recursively for
                       log files to be imported.
-    --createmissing   if set, then all testcases without tcid are created 
+    --createmissing   if set, then all testcases without tcid are created
                       when importing.
-    --updatetestcase  if set, then testcase information on RQM will be updated 
+    --updatetestcase  if set, then testcase information on RQM will be updated
                       bases on robot testfile.
-    --dryrun          if set, then verify all input arguments 
+    --dryrun          if set, then verify all input arguments
                       (includes RQM authentication) and show what would be done.
 
 The below command is simple usage witth all required arguments to import
@@ -146,12 +185,12 @@ importing into RQM:
 
     *** Test Cases ***
     Testcase 01
-       [Documentation]   This test is traceable with provided tcid  
+       [Documentation]   This test is traceable with provided tcid
        [Tags]   TCID-1001   FID-112   FID-111    robotfile-https://github.com/test-fullautomation
        Log      This is Testcase 01
 
     Testcase 02
-       [Documentation]  This new testcase will be created if --createmissing argument 
+       [Documentation]  This new testcase will be created if --createmissing argument
                    ...  is provided when importing
        [Tags]   FID-113  robotfile-https://github.com/test-fullautomation
        Log      This is Testcase 02
@@ -203,7 +242,7 @@ Contributors
 License
 -------
 
-Copyright 2020-2022 Robert Bosch GmbH
+Copyright 2020-2024 Robert Bosch GmbH
 
 Licensed under the Apache License, Version 2.0 (the \"License\"); you
 may not use this file except in compliance with the License. You may

{robotframework-robotlog2rqm-1.2.0 → robotframework-robotlog2rqm-1.2.3}/README.rst

@@ -1,4 +1,4 @@
-.. Copyright 2020-2022 Robert Bosch GmbH
+.. Copyright 2020-2024 Robert Bosch GmbH
 
 .. Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -15,19 +15,19 @@
 RobotLog2RQM Description
 ========================
 
-The Python package **RobotLog2RQM** provides ability to import `Robot Framework 
-test result`_ as ***.xml** format file(s) to `IBM® Rational® Quality Manager`_ 
+The Python package **RobotLog2RQM** provides ability to import `Robot Framework
+test result`_ as ***.xml** format file(s) to `IBM® Rational® Quality Manager`_
 (RQM) for test management.
 
 **RobotLog2RQM** tool helps to:
 
-* Create all required resources (*Test Case Excution Record*, *Test Case 
+* Create all required resources (*Test Case Excution Record*, *Test Case
   Execution Result*, ...) for new testcase on RQM.
 * Link all testcases to provided testplan.
 * Add new test result for existing testcase on RQM.
 * Update existing testcase on RQM.
 
-**RobotLog2RQM** tool is operating system independent and only works with 
+**RobotLog2RQM** tool is operating system independent and only works with
 Python 3.
 
 How to install
@@ -41,36 +41,64 @@ How to install
 
       pip install RobotLog2RQM
 
-   `RobotLog2RQM in PyPi <https://pypi.org/project/RobotLog2RQM/>`_
+   `RobotLog2RQM in PyPi <https://pypi.org/project/robotframework-robotlog2rqm/>`_
 
 2. Installation via GitHub (recommended for developers)
 
-   Clone the **python-robotlog2rqm** repository to your machine.
+   * Clone the **robotframework-robotlog2rqm** repository to your machine.
 
-   .. code::
+     .. code::
 
-      git clone https://github.com/test-fullautomation/python-robotlog2rqm.git
+        git clone https://github.com/test-fullautomation/robotframework-robotlog2rqm.git
 
-   `RobotLog2RQM in GitHub <https://github.com/test-fullautomation/python-robotlog2rqm>`_
+     `RobotLog2RQM in GitHub <https://github.com/test-fullautomation/robotframework-robotlog2rqm>`_
 
-   Use the following command to install **RobotLog2RQM**:
+   * Install dependencies
 
-   .. code::
+     **RobotLog2RQM** requires some additional Python libraries. Before you install the cloned repository sources
+     you have to install the dependencies manually. The names of all related packages you can find in the file ``requirements.txt``
+     in the repository root folder. Use pip to install them:
+
+     .. code::
+
+        pip install -r ./requirements.txt
+
+     Additionally install **LaTeX** (recommended: TeX Live). This is used to render the documentation.
+
+   * Configure dependencies
+
+     The installation of **RobotLog2RQM** includes to generate the documentation in PDF format. This is done by
+     an application called **GenPackageDoc**, that is part of the installation dependencies (see ``requirements.txt``).
+
+     **GenPackageDoc** uses **LaTeX** to generate the documentation in PDF format. Therefore **GenPackageDoc** needs to know where to find
+     **LaTeX**. This is defined in the **GenPackageDoc** configuration file
+
+     .. code::
+
+        packagedoc\packagedoc_config.json
+
+     Before you start the installation you have to introduce the following environment variable, that is used in ``packagedoc_config.json``:
+
+     - ``GENDOC_LATEXPATH`` : path to ``pdflatex`` executable
+
+   * Use the following command to install **RobotLog2RQM**:
+
+     .. code::
 
-      setup.py install
+        python setup.py install
 
-After succesful installation, the executable file **RobotLog2RQM** 
-will be available (under *Scripts* folder of Python on Windows 
+After succesful installation, the executable file **RobotLog2RQM**
+will be available (under *Scripts* folder of Python on Windows
 and *~/.local/bin/* folder on Linux).
 
-In case above location is added to **PATH** environment variable 
+In case above location is added to **PATH** environment variable
 then you can run it directly as operation system's command.
 
 How to use
 ----------
 
-**RobotLog2RQM** tool requires the Robot Framework ``output.xml`` result file(s) 
-which will be imported, RQM information(e.g. host url, project, ...) and user 
+**RobotLog2RQM** tool requires the Robot Framework ``output.xml`` result file(s)
+which will be imported, RQM information(e.g. host url, project, ...) and user
 credential(user name and password) to interact with RQM resources.
 
 Use below command to get tools's usage:
@@ -84,15 +112,15 @@ The usage should be showed as below:
 
 ::
 
-   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive] 
-                       [--createmissing] [--updatetestcase] [--dryrun] 
+   usage: RobotLog2RQM (RobotXMLResult to RQM importer) [-h] [-v] [--recursive]
+                       [--createmissing] [--updatetestcase] [--dryrun]
                        resultxmlfile host project user password testplan
 
-   RobotLog2RQM imports XML result files (default: output.xml) generated by the 
+   RobotLog2RQM imports XML result files (default: output.xml) generated by the
    Robot Framework into an IBM Rational Quality Manager.
 
    positional arguments:
-   resultxmlfile     absolute or relative path to the xml result file 
+   resultxmlfile     absolute or relative path to the xml result file
                      or directory of result files to be imported.
    host              RQM host url.
    project           project on RQM.
@@ -103,17 +131,17 @@ The usage should be showed as below:
    optional arguments:
    -h, --help        show this help message and exit
    -v, --version     Version of the RobotLog2RQM importer.
-   --recursive       if set, then the path is searched recursively for 
+   --recursive       if set, then the path is searched recursively for
                      log files to be imported.
-   --createmissing   if set, then all testcases without tcid are created 
+   --createmissing   if set, then all testcases without tcid are created
                      when importing.
-   --updatetestcase  if set, then testcase information on RQM will be updated 
+   --updatetestcase  if set, then testcase information on RQM will be updated
                      bases on robot testfile.
-   --dryrun          if set, then verify all input arguments 
+   --dryrun          if set, then verify all input arguments
                      (includes RQM authentication) and show what would be done.
 
 
-The below command is simple usage witth all required arguments to import 
+The below command is simple usage witth all required arguments to import
 Robot Framework results into RQM:
 
 ::
@@ -147,25 +175,25 @@ Sample Robot testcase which contains neccessary information for importing into R
 
    *** Test Cases ***
    Testcase 01
-      [Documentation]   This test is traceable with provided tcid  
+      [Documentation]   This test is traceable with provided tcid
       [Tags]   TCID-1001   FID-112   FID-111    robotfile-https://github.com/test-fullautomation
       Log      This is Testcase 01
 
    Testcase 02
-      [Documentation]  This new testcase will be created if --createmissing argument 
+      [Documentation]  This new testcase will be created if --createmissing argument
                   ...  is provided when importing
       [Tags]   FID-113  robotfile-https://github.com/test-fullautomation
       Log      This is Testcase 02
 
-After getting ``output.xml`` result file, use below command to import that 
-result file into testplan ID ``720`` of ``ROBFW-AIO`` project which is hosted 
-at ``https://sample-rqm-host.com`` 
+After getting ``output.xml`` result file, use below command to import that
+result file into testplan ID ``720`` of ``ROBFW-AIO`` project which is hosted
+at ``https://sample-rqm-host.com``
 
 ::
 
    RobotLog2RQM output.xml https://sample-rqm-host.com ROBFW-AIO test_user test_pw 720
 
-Then, open RQM with your favourite browser and you will see that the test case 
+Then, open RQM with your favourite browser and you will see that the test case
 execution records and their results are imported in the given testplan ID.
 
 Sourcecode Documentation
@@ -179,7 +207,7 @@ Feedback
 
 To give us a feedback, you can send an email to `Thomas Pollerspöck`_.
 
-In case you want to report a bug or request any interesting feature, 
+In case you want to report a bug or request any interesting feature,
 please don't hesitate to raise a ticket.
 
 Maintainers
@@ -204,7 +232,7 @@ Contributors
 License
 -------
 
-Copyright 2020-2022 Robert Bosch GmbH
+Copyright 2020-2024 Robert Bosch GmbH
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -229,4 +257,4 @@ limitations under the License.
 .. _Nguyen Huynh Tri Cuong: mailto:Cuong.NguyenHuynhTri@vn.bosch.com
 .. _Mai Dinh Nam Son: mailto:Son.MaiDinhNam@vn.bosch.com
 .. _Tran Hoang Nguyen: mailto:Nguyen.TranHoang@vn.bosch.com
-.. _Holger Queckenstedt: mailto:Holger.Queckenstedt@de.bosch.com
+.. _Holger Queckenstedt: mailto:Holger.Queckenstedt@de.bosch.com