PyPI - robotframework-testdoc - Versions diffs - 0.3.0__tar.gz → 0.3.1__tar.gz - Mend

robotframework-testdoc 0.3.0tar.gz → 0.3.1tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/.gitignore RENAMED Viewed

@@ -12,4 +12,8 @@ image.png
 output_doc_robot.html
 devel.html
 build/**
-uv.lock
+uv.lock
+atest/output_classic.html
+atest/output_big.html
+results/
+oc_output.html

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-testdoc
-Version: 0.3.0
+Version: 0.3.1
 Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
 Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
 Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
@@ -9,13 +9,13 @@ License: Apache-2.0
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: click
 Requires-Dist: jinja2
+Requires-Dist: pydantic
 Requires-Dist: robotframework
 Requires-Dist: tomli
 Provides-Extra: dev
@@ -110,6 +110,20 @@ testdoc --hide-source tests/ TestDocumentation.html
 testdoc --hide-keywords tests/ TestDocumentation.html
 ```
+## Visualization of Keywords
+Keywords are visualized in a specific design and to replicate the robot framework test case structure (model) as best as possible.
+### User / Library Keywords called in a Test Case Body
+This view does actually replicate the robot framework suite file with the ``*** Test Cases ***`` section, the ``Test Case Name`` and the ``Test Case Body``.
+![alt text](docs/test_keywords_visualization.png)
+### User Keyword defined in a Test Suite
+![alt text](docs/suite_keywords_visualization.png)
 ## Robot Framework Tags
 The commandline arguments ``include`` & ``exclude`` have more or less the same functionality like in the known ``robot ...`` command.
 You can decide to weither include and / or exclude specific test cases into the test documentation.
@@ -167,6 +181,8 @@ border_color = "#CCCCCC"
 text_color = "#CCCCCC"
 title_color = "#00ffb9"
 robot_icon = "#00ffb9"
+code_area_background = "#303030"
+code_area_foreground = "#f1f1f1"
 ```
 ## HTML Template Selection
@@ -178,7 +194,7 @@ These template can be configured via ``cli arguments`` or within a ``.toml confi
 - v2
-### Available HTML Templates
+### Available HTML Templates - NOT RECOMMENDED
 You can choose one of the following designs:
 - v1
@@ -259,6 +275,8 @@ border_color = "#CCCCCC"
 text_color = "#CCCCCC"
 title_color = "#00ffb9"
 robot_icon = "#00ffb9"
+code_area_background = "#303030"
+code_area_foreground = "#f1f1f1"
 ```
 > [!TIP]
@@ -276,4 +294,8 @@ robot_icon = "#00ffb9"
 #### Robot / Default
-![alt text](docs/style_robot.png)
+![alt text](docs/style_robot.png)
+## Contribution & Development
+See [Development.md](./DEVELOPMENT.md) for more information about contributing & developing this library.

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/README.md RENAMED Viewed

@@ -81,6 +81,20 @@ testdoc --hide-source tests/ TestDocumentation.html
 testdoc --hide-keywords tests/ TestDocumentation.html
 ```
+## Visualization of Keywords
+Keywords are visualized in a specific design and to replicate the robot framework test case structure (model) as best as possible.
+### User / Library Keywords called in a Test Case Body
+This view does actually replicate the robot framework suite file with the ``*** Test Cases ***`` section, the ``Test Case Name`` and the ``Test Case Body``.
+![alt text](docs/test_keywords_visualization.png)
+### User Keyword defined in a Test Suite
+![alt text](docs/suite_keywords_visualization.png)
 ## Robot Framework Tags
 The commandline arguments ``include`` & ``exclude`` have more or less the same functionality like in the known ``robot ...`` command.
 You can decide to weither include and / or exclude specific test cases into the test documentation.
@@ -138,6 +152,8 @@ border_color = "#CCCCCC"
 text_color = "#CCCCCC"
 title_color = "#00ffb9"
 robot_icon = "#00ffb9"
+code_area_background = "#303030"
+code_area_foreground = "#f1f1f1"
 ```
 ## HTML Template Selection
@@ -149,7 +165,7 @@ These template can be configured via ``cli arguments`` or within a ``.toml confi
 - v2
-### Available HTML Templates
+### Available HTML Templates - NOT RECOMMENDED
 You can choose one of the following designs:
 - v1
@@ -230,6 +246,8 @@ border_color = "#CCCCCC"
 text_color = "#CCCCCC"
 title_color = "#00ffb9"
 robot_icon = "#00ffb9"
+code_area_background = "#303030"
+code_area_foreground = "#f1f1f1"
 ```
 > [!TIP]
@@ -247,4 +265,8 @@ robot_icon = "#00ffb9"
 #### Robot / Default
-![alt text](docs/style_robot.png)
+![alt text](docs/style_robot.png)
+## Contribution & Development
+See [Development.md](./DEVELOPMENT.md) for more information about contributing & developing this library.

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/pyproject.toml RENAMED Viewed

@@ -7,7 +7,7 @@ name = "robotframework-testdoc"
 dynamic = ["version"]
 description = "A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts."
 readme = "README.md"
-requires-python = ">=3.9"
+requires-python = ">=3.10"
 authors = [
     { name = "Marvin Klerx", email = "marvinklerx20@gmail.com" }
 ]
@@ -16,7 +16,6 @@ license = { text = "Apache-2.0" }
 classifiers = [
   "Development Status :: 4 - Beta",
   "Programming Language :: Python",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12"
@@ -26,7 +25,8 @@ dependencies = [
     "click",
     "robotframework",
     "jinja2",
-    "tomli"
+    "tomli",
+    "pydantic"
 ]
 [project.optional-dependencies]

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/src/testdoc/html/templates/v2/jinja_template_03.html RENAMED Viewed

@@ -16,35 +16,53 @@
 {% macro render_test_cases(suite) %}
     {% if suite.tests %}
         <div class="suite-header mb-3 p-3" data-suite-id="{{ suite.id }}" style="border: 1px solid {{ colors.border_color }}; border-radius: .375rem; background: {{ colors.inner_color }};">
-            <div><strong>Generic Suite Details:</strong></div>
+            <div><strong>Test Suite Details:</strong></div>
+            <hr>
             <table style="width: 100%; border-collapse: collapse;">
                 <tr>
-                    <td style="width: 10%; font-weight: bold;">📁 Suite Name:</td>
+                    <td style="width: 15%; font-weight: bold;">📁 Suite Name:</td>
                     <td style="text-align: left;">{{ suite.name }}</td>
                 </tr>
                 {% if not suite.is_folder %}
                     <tr>
-                        <td style="width: 10%; font-weight: bold;">📄 File Name:</td>
+                        <td style="width: 15%; font-weight: bold;">📄 File Name:</td>
                         <td style="text-align: left;">{{ suite.filename }}</td>
                     </tr>
                 {% endif %}
                 <tr>
-                    <td style="width: 10%; font-weight: bold;">📊 Number of Tests:</td>
+                    <td style="width: 15%; font-weight: bold;">📊 Number of Tests:</td>
                     <td style="text-align: left;">{{ suite.num_tests }}</td>
                 </tr>
                 {% if suite.doc is not none %}
                 <tr>
-                    <td style="width: 10%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
+                    <td style="width: 15%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
                     <td style="text-align: left;">{{ suite.doc }}</td>
                 </tr>
                 {% endif %}
+                {% if suite.source is not none %}
+                    <tr>
+                        <td style="width: 15%; font-weight: bold; vertical-align: top;">🔗 Source:</td>
+                        <td style="text-align: left;">
+                            <a href="{{ suite.source }}" target="_blank">{{ suite.source }}</a>
+                        </td>
+                    </tr>
+                {% endif %}
                 {% if suite.metadata is not none %}
                 <tr>
-                    <td style="width: 10%; font-weight: bold; vertical-align: top;">⚙️ Metadata:</td>
+                    <td style="width: 15%; font-weight: bold; vertical-align: top;">⚙️ Metadata:</td>
                     <td style="text-align: left;">{{ suite.metadata }}</td>
                 </tr>
                 {% endif %}
             </table>
+            {% if suite.user_keywords is not none %}
+                <br>
+                <div class="keywords-block keywords-block-div"><strong>🔑 Suite User Keywords:</strong></div>
+                {% if suite.user_keywords %}
+                    <pre class="keywords-block keywords-block-pre">
+*** Keywords ***
+    {{ suite.user_keywords | join('\n    ') }}</pre>
+                {% endif %}
+            {% endif %}
         </div>
         {% for test in suite.tests %}
             <div class="card mb-3 test-card" data-suite-id="{{ suite.id }}">
@@ -57,6 +75,8 @@
                 </div>
                 <div id="collapse-{{ suite.id }}-{{ loop.index }}" class="collapse">
                     <div class="card-body">
+                        <div class="keywords-block"><strong>Test Case Details:</strong></div>
+                        <hr class="keywords-block">
                         <table style="width: 100%; border-collapse: collapse;">
                             {% set has_info = test.doc is not none or test.source is not none or test.tags is not none or test.keywords is not none %}
                             {% if test.doc is not none %}
@@ -67,7 +87,7 @@
                             {% endif %}
                             {% if test.source is not none %}
                                 <tr>
-                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">🔗 Source:</td>
+                                    <td style="width: 15%; font-weight: bold; vertical-align: top;">🔗 Source:</td>
                                     <td style="text-align: left;">
                                         <a href="{{ test.source }}" target="_blank">{{ test.source }}</a>
                                     </td>
@@ -75,30 +95,31 @@
                             {% endif %}
                             {% if test.tags is not none %}
                                 <tr>
-                                    <td style="width: 10%; font-weight: bold;">🏷 Tags:</td>
+                                    <td style="width: 15%; font-weight: bold;">🏷 Tags:</td>
                                     <td style="text-align: left;">
                                         {{ test.tags | join(', ') }}
                                     </td>
                                 </tr>
                             {% endif %}
-                            {% if test.keywords is not none %}
-                                <tr>
-                                    <td style="width: 10%; font-weight: bold; vertical-align: top;">🔑 Keywords:</td>
-                                    <td style="text-align: left;">
-                                        {% if test.keywords %}
-                                            <pre>- {{ test.keywords | join('\n- ') }}</pre>
-                                        {% endif %}
-                                    </td>
-                                </tr>
-                            {% endif %}
                             {% if not has_info %}
                                 <tr>
-                                    <td class="info-msg" style="width: 10%; vertical-align: top; text-align: center;">
+                                    <td class="info-msg" style="width: 15%; vertical-align: top; text-align: center;">
                                         No Details Available / Enabled !
                                     </td>
                                 </tr>
                             {% endif %}
                         </table>
+                        {% if test.keywords is not none %}
+                            <br>
+                            <div class="keywords-block keywords-block-div"><strong>🔑 Keywords / Test Case Body:</strong></div>
+                            {% if test.keywords %}
+                                <pre class="keywords-block keywords-block-pre">
+*** Test Cases ***
+{{ test.name }}
+    {{ test.keywords | join('\n    ') }}
+                                </pre>
+                            {% endif %}
+                        {% endif %}
                     </div>
                 </div>
             </div>
@@ -106,25 +127,34 @@
     {% endif %}
     {% if suite.sub_suites %}
         <div class="suite-header mb-3 p-3" data-suite-id="{{ suite.id }}" style="border: 1px solid {{ colors.border_color }}; border-radius: .375rem; background: {{ colors.inner_color }};">
-            <div><strong>Generic Parent Suite Details:</strong></div>
+            <div><strong>Parent Test Suite Details:</strong></div>
+            <hr>
             <table style="width: 100%; border-collapse: collapse;">
                 <tr>
-                    <td style="width: 10%; font-weight: bold;">📁 Suite Name:</td>
+                    <td style="width: 15%; font-weight: bold;">📁 Suite Name:</td>
                     <td style="text-align: left;">{{ suite.name }}</td>
                 </tr>
                 <tr>
-                    <td style="width: 10%; font-weight: bold;">📊 Number of Tests:</td>
+                    <td style="width: 15%; font-weight: bold;">📊 Number of Tests:</td>
                     <td style="text-align: left;">{{ suite.total_tests }}</td>
                 </tr>
                 {% if suite.doc is not none %}
                 <tr>
-                    <td style="width: 10%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
+                    <td style="width: 15%; font-weight: bold; vertical-align: top;">📝 Docs:</td>
                     <td style="text-align: left;">{{ suite.doc }}</td>
                 </tr>
                 {% endif %}
+                {% if suite.source is not none %}
+                    <tr>
+                        <td style="width: 15%; font-weight: bold; vertical-align: top;">🔗 Source:</td>
+                        <td style="text-align: left;">
+                            <a href="{{ suite.source }}" target="_blank">{{ suite.source }}</a>
+                        </td>
+                    </tr>
+                {% endif %}
                 {% if suite.metadata is not none %}
                 <tr>
-                    <td style="width: 10%; font-weight: bold; vertical-align: top;">⚙️ Metadata:</td>
+                    <td style="width: 15%; font-weight: bold; vertical-align: top;">⚙️ Metadata:</td>
                     <td style="text-align: left;">{{ suite.metadata }}</td>
                 </tr>
                 {% endif %}
@@ -210,6 +240,21 @@
             .sidebar { min-width: 120px; max-width: 180px; }
             .main-content { padding: 10px; }
         }
+        .keywords-block,
+        .keywords-block pre {
+        color: {{ colors.text_color }};
+        }
+        .keywords-block-div {
+            margin-bottom: 8px;
+        }
+        .keywords-block-pre {
+            background-color: {{ colors.code_area_background }};
+            color: {{ colors.code_area_foreground }};
+            border-radius: 8px;
+            padding: 12px 14px;
+        }
     </style>
 </head>
 <body>

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/LICENSE RENAMED Viewed

File without changes

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/src/testdoc/default.toml RENAMED Viewed

File without changes

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/src/testdoc/html/images/robotframework.svg RENAMED Viewed

File without changes

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/src/testdoc/html/templates/v1/jinja_template_01.html RENAMED Viewed

File without changes

{robotframework_testdoc-0.3.0 → robotframework_testdoc-0.3.1}/src/testdoc/html/templates/v1/jinja_template_02.html RENAMED Viewed

File without changes

robotframework-testdoc 0.3.0__tar.gz → 0.3.1__tar.gz

robotframework-testdoc 0.3.0tar.gz → 0.3.1tar.gz