robotframework-testdoc 0.3.0__tar.gz

robotframework_testdoc-0.3.0/.gitignore

@@ -0,0 +1,15 @@
+__pycache__/**
+src/robotframework_testdoc.egg-info/**
+**/__pycache__/**.pyc
+.vscode/launch.json
+.vscode/
+dist/
+*.egg-info/
+output_doc.html
+output.html
+src/testdoc/html/templates/jinja_template_02.html
+image.png
+output_doc_robot.html
+devel.html
+build/**
+uv.lock

robotframework_testdoc-0.3.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

robotframework_testdoc-0.3.0/PKG-INFO

@@ -0,0 +1,279 @@
+Metadata-Version: 2.4
+Name: robotframework-testdoc
+Version: 0.3.0
+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
+Author-email: Marvin Klerx <marvinklerx20@gmail.com>
+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-Dist: click
+Requires-Dist: jinja2
+Requires-Dist: robotframework
+Requires-Dist: tomli
+Provides-Extra: dev
+Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: robotframework-robocop; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Robot Framework TestDoc
+
+## GitHub Project
+
+Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/robotframework-testdoc)
+
+## Statistics
+
+[![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)  
+[![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)   
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)    
+[![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)   
+[![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)   
+
+## Installation
+
+Install the tool using the following command:
+```shell
+pip install robotframework-testdoc
+```
+
+> [!IMPORTANT]
+> Preconditions: Python & Pip Installation.
+
+## Usage
+
+### Basic Usage
+```shell
+testdoc suite_directory output.html
+# or
+testdoc suite_file output.html
+```
+
+### Extended Usage
+```shell
+testdoc [OPTIONS] suite_directory output.html
+```
+
+> [!TIP]
+> **Included Help:** Please execute ``testdoc --help`` for further details about the commandline arguments or see the examples below.
+
+## Examples
+
+Below you can find some example of using the testdoc library.  
+
+> [!TIP]
+> Of course, you can combine all of them!
+
+```shell
+# Generating docu without option
+testdoc tests/ TestDocumentation.html
+
+# Generating docu with new title, new root suite name, new root suite documentation text & new metadata
+testdoc -t "Robot Framework Test Automation" -n "System Tests" -d "Root Suite Documentation" -m "Root Suite Metadata" tests/ TestDocumentation.html
+
+# Generating docu with source prefix to navigate directly to its gitlab file path
+testdoc -s "https://gitlab.com/myrepository" tests/ TestDocumentation.html
+
+# Generating docu only with specific mentioned tags to include & exclude 
+testdoc -i ManagementUI -e LongTime tests/ TestDocumentation.html
+
+# Generating docu only with multiple specific mentioned tags to include
+testdoc -i ManagementUI -i MQTT tests/ TestDocumentation.html
+
+# Generating docu only with new metadata for root suite object
+testdoc -m Version=0.1.1-dev -m Tester=RobotExpert tests/ TestDocumentation.html
+
+# Generating docu - hide tags information
+testdoc --hide-tags tests/ TestDocumentation.html
+
+# Generating docu - hide test case documentation texts
+testdoc --hide-test-doc tests/ TestDocumentation.html
+
+# Generating docu - hide test suite documentation texts
+testdoc --hide-suite-doc tests/ TestDocumentation.html
+
+# Generating docu - hide source information
+testdoc --hide-source tests/ TestDocumentation.html
+
+# Generating docu - hide keyword information (keyword calls in tests)
+testdoc --hide-keywords tests/ TestDocumentation.html
+```
+
+## 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.
+
+## External Configuration File
+The idea of the external configuration file is, having a central place for passing the known CMD arguments via file instead of CMD parameters.   
+This will keep your CMD line call simple & clean.
+
+For using this config file, just call the following command:
+```shell
+# Generate docu with options defined in TOML file
+testdoc -c path/to/config.toml tests/ TestDocumentation.html
+```
+
+### pyproject.toml vs. custom toml file
+
+Using the ``pyproject`` requires to define the ``testdoc`` sections with the prefix ``tool.``   
+Example section start: ``[tool.testdoc]``
+
+Using your own custom toml-file, does not require you to use the prefix. Here, you can just use ``[testdoc]`` as section header.
+
+
+### Example Configuration File
+```toml
+[tool.testdoc]
+title = "New title of HTML document"
+name = "New name of root suite element"
+doc = "New doc text of root suite element"
+sourceprefix = "gitlab::https://gitlab.com/myrepo/repo_path"
+include = ["TagA", "TagB"]
+exclude = ["TagC"]
+hide_tags = true
+hide_test_doc = true
+hide_suite_doc = true
+hide_source = true
+hide_keywords = true
+style = "blue"
+verbose_mode = false
+
+[tool.testdoc.metadata]
+Author = "Your-Name"
+Version = "1.0.0"
+Source = "AnySourceAsMetaData"
+
+[tool.testdoc.colors]
+# Use predefined theme:
+default = "blue"
+# OR
+# Use custom colors:
+background = "#000028"
+inner_color = "#000028"
+button_active_color = "#193966"
+button_hover_color = "#193966"
+border_color = "#CCCCCC"
+text_color = "#CCCCCC"
+title_color = "#00ffb9"
+robot_icon = "#00ffb9"
+```
+
+## HTML Template Selection
+
+You can choose between multiple HTML template for the design of your test documentation.    
+These template can be configured via ``cli arguments`` or within a ``.toml configuration file`` with the parameter ``html_template (-ht / --html-template)``.
+
+### Default Design
+
+- v2
+
+### Available HTML Templates
+
+You can choose one of the following designs:
+- v1
+- v2
+
+### Version 1
+
+#### Visit Tests
+
+![alt text](docs/html_v1_common.png)
+
+### Version 2
+
+#### Visit Tests on Root Suite Level
+
+![alt text](docs/html_v2_root.png)
+
+#### Visit Tests on Suite File Level
+
+![alt text](docs/html_v2_suitefile.png)
+
+## Theme Selection / Color Configuration
+
+You can select between several themes (color configurations) for your HTML document to create!
+
+> [!CAUTION]
+> This is only possible via toml-configuration file, but not via cmd args directly!
+
+### Default Themes
+
+There are a few predefined default themes available that you can choose via the toml-configuration file OR cli.   
+Therefore, please use the following syntax: for the toml file
+```toml
+[colors]
+# Use the default theme
+default = "default"
+default = 0
+# Use the dark theme
+default = "dark"
+default = 1
+# Use the blue theme
+default = "blue"
+default = 2
+# Use the robot theme
+default = "robot"
+default = 3
+# Use the dark robot theme
+default = "robot_dark"
+default = 4
+# Use the green theme
+default = "green"
+default = 5
+```
+
+For setting it via CLI, please use the following:
+```shell
+# Applying dark theme
+testdoc ... -S dark PATH OUTPUT_FILE
+
+# Applying blue theme
+testdoc ... --style blue PATH OUTPUT_FILE
+```
+
+> [!TIP]
+> You can select the default theme using either a string value or an integer value.
+
+### Custom Themes
+
+You can apply your own custom theme to modify the colors of the created HTML document.   
+Use the following syntax & parameters in your toml-configuration file, to overwrite the predefined themes:
+```toml
+[colors]
+background = "#000028"
+inner_color = "#000028"
+button_active_color = "#193966"
+button_hover_color = "#193966"
+border_color = "#CCCCCC"
+text_color = "#CCCCCC"
+title_color = "#00ffb9"
+robot_icon = "#00ffb9"
+```
+
+> [!TIP]
+> Please make sure to configure all available color values from this example — missing values may cause layout or rendering issues in the generated HTML document!
+
+### Default Themes - Screenshot
+
+#### Dark
+
+![alt text](docs/style_dark.png)
+
+#### Blue
+
+![alt text](docs/style_blue.png)
+
+#### Robot / Default
+
+![alt text](docs/style_robot.png)