robotframework-testdoc 0.2.0__tar.gz → 0.2.3__tar.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.

Potentially problematic release.

This version of robotframework-testdoc might be problematic. Click here for more details.

Files changed (47) hide show
  1. robotframework_testdoc-0.2.0/.github/workflows/build-publish.yml → robotframework_testdoc-0.2.3/.github/workflows/build.yml +23 -13
  2. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/.github/workflows/release.yml +9 -0
  3. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/PKG-INFO +19 -5
  4. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/README.md +9 -3
  5. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/pyproject.toml +16 -2
  6. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/PKG-INFO +19 -5
  7. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/SOURCES.txt +1 -1
  8. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/.gitignore +0 -0
  9. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/LICENSE +0 -0
  10. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/atest/config/config_with_colors.toml +0 -0
  11. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/atest/config/testdoc.toml +0 -0
  12. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/atest/config_pyproject/example_pyproject.toml +0 -0
  13. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/atest/test_cli.py +0 -0
  14. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/atest/test_cli.robot +0 -0
  15. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/docs/html_v1_common.png +0 -0
  16. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/docs/html_v2_root.png +0 -0
  17. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/docs/html_v2_suitefile.png +0 -0
  18. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/docs/style_blue.png +0 -0
  19. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/docs/style_dark.png +0 -0
  20. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/docs/style_robot.png +0 -0
  21. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/setup.cfg +0 -0
  22. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/dependency_links.txt +0 -0
  23. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/entry_points.txt +0 -0
  24. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/requires.txt +0 -0
  25. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/top_level.txt +0 -0
  26. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/__init__.py +0 -0
  27. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/__main__.py +0 -0
  28. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/cli.py +0 -0
  29. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/default.toml +0 -0
  30. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/helper/cliargs.py +0 -0
  31. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/helper/datetimeconverter.py +0 -0
  32. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/helper/logger.py +0 -0
  33. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/helper/pathconverter.py +0 -0
  34. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/helper/toml_reader.py +0 -0
  35. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/images/robotframework.svg +0 -0
  36. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/templates/v1/jinja_template_01.html +0 -0
  37. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/templates/v1/jinja_template_02.html +0 -0
  38. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/templates/v2/jinja_template_03.html +0 -0
  39. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/themes/__init__.py +0 -0
  40. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/themes/theme_config.py +0 -0
  41. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html/themes/themes.py +0 -0
  42. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/html_rendering/render.py +0 -0
  43. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/parser/modifier/sourceprefixmodifier.py +0 -0
  44. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/parser/modifier/suitefilemodifier.py +0 -0
  45. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/parser/testcaseparser.py +0 -0
  46. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/parser/testsuiteparser.py +0 -0
  47. {robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/testdoc/testdoc.py +0 -0
robotframework_testdoc-0.2.0/.github/workflows/build-publish.yml → robotframework_testdoc-0.2.3/.github/workflows/build.yml RENAMED
@@ -1,10 +1,9 @@
1
- name: Build Python Package
1
+ name: Build & Test Python Package
2
2
 
3
3
  on:
4
4
  push:
5
5
  branches:
6
6
  - main
7
- - '**'
8
7
  tags-ignore:
9
8
  - 'v*.*.*'
10
9
  paths:
@@ -20,9 +19,8 @@ on:
20
19
  - pyproject.toml
21
20
 
22
21
  jobs:
23
- build:
22
+ code-quality:
24
23
  runs-on: ubuntu-latest
25
-
26
24
  steps:
27
25
  - name: Checkout Repository
28
26
  uses: actions/checkout@v3
@@ -40,9 +38,28 @@ jobs:
40
38
  - name: Lint with Ruff
41
39
  run: ruff check .
42
40
 
41
+ test-build:
42
+ runs-on: ubuntu-latest
43
+ strategy:
44
+ matrix:
45
+ python-version: ["3.9", "3.10", "3.11", "3.12"]
46
+ steps:
47
+ - name: Checkout Repository
48
+ uses: actions/checkout@v4
49
+
50
+ - name: Set up Python
51
+ uses: actions/setup-python@v5
52
+ with:
53
+ python-version: ${{ matrix.python-version }}
54
+
55
+ - name: Install Build Dependencies
56
+ run: |
57
+ python -m pip install --upgrade pip
58
+ pip install build ruff pytest
59
+
43
60
  - name: Build Package
44
61
  run: python -m build
45
-
62
+
46
63
  - name: Test CLI Command
47
64
  run: |
48
65
  pip install .
@@ -50,11 +67,4 @@ jobs:
50
67
 
51
68
  - name: Run Unit Tests
52
69
  run: pytest atest/
53
-
54
- # - name: Publish to TestPyPI
55
- # env:
56
- # TWINE_USERNAME: __token__
57
- # TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
58
- # run: |
59
- # pip install twine
60
- # twine upload --repository-url https://test.pypi.org/legacy/ dist/*
70
+
{robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/.github/workflows/release.yml RENAMED
@@ -53,3 +53,12 @@ jobs:
53
53
  TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
54
54
  run: twine upload dist/*
55
55
 
56
+ # Backup:
57
+ # - name: Publish to TestPyPI
58
+ # env:
59
+ # TWINE_USERNAME: __token__
60
+ # TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
61
+ # run: |
62
+ # pip install twine
63
+ # twine upload --repository-url https://test.pypi.org/legacy/ dist/*
64
+
{robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/PKG-INFO RENAMED
@@ -1,9 +1,17 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: robotframework-testdoc
3
- Version: 0.2.0
3
+ Version: 0.2.3
4
4
  Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
5
5
  Author-email: Marvin Klerx <marvinklerx20@gmail.com>
6
- License: MIT
6
+ License: Apache-2.0
7
+ Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
8
+ Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
7
15
  Requires-Python: >=3.7
8
16
  Description-Content-Type: text/markdown
9
17
  License-File: LICENSE
@@ -15,11 +23,17 @@ Dynamic: license-file
15
23
 
16
24
  # Robot Framework TestDoc
17
25
 
26
+ ## GitHub Project
27
+
28
+ Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/robotframework-testdoc)
29
+
18
30
  ## Statistics
19
31
 
20
- [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
21
- [![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
22
- [![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
32
+ [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
33
+ [![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)
34
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)
35
+ [![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
36
+ [![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
23
37
 
24
38
  ## Installation
25
39
 
{robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/README.md RENAMED
@@ -1,10 +1,16 @@
1
1
  # Robot Framework TestDoc
2
2
 
3
+ ## GitHub Project
4
+
5
+ Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/robotframework-testdoc)
6
+
3
7
  ## Statistics
4
8
 
5
- [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
6
- [![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
7
- [![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
9
+ [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
10
+ [![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)
11
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)
12
+ [![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
13
+ [![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
8
14
 
9
15
  ## Installation
10
16
 
{robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/pyproject.toml RENAMED
@@ -4,14 +4,24 @@ build-backend = "setuptools.build_meta"
4
4
 
5
5
  [project]
6
6
  name = "robotframework-testdoc"
7
- version = "0.2.0"
7
+ version = "0.2.3"
8
8
  description = "A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts."
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.7"
11
11
  authors = [
12
12
  { name = "Marvin Klerx", email = "marvinklerx20@gmail.com" }
13
13
  ]
14
- license = { text = "MIT" }
14
+ license = { text = "Apache-2.0" }
15
+
16
+ classifiers = [
17
+ "Development Status :: 4 - Beta",
18
+ "Programming Language :: Python",
19
+ # "Programming Language :: Python :: 3.8",
20
+ "Programming Language :: Python :: 3.9",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12"
24
+ ]
15
25
 
16
26
  dependencies = [
17
27
  "click",
@@ -23,6 +33,10 @@ dependencies = [
23
33
  [project.scripts]
24
34
  testdoc = "testdoc.cli:main"
25
35
 
36
+ [project.urls]
37
+ Repository = "https://github.com/MarvKler/robotframework-testdoc"
38
+ Issues = "https://github.com/MarvKler/robotframework-testdoc/issues"
39
+
26
40
  [tool.setuptools]
27
41
  include-package-data = true
28
42
 
{robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/PKG-INFO RENAMED
@@ -1,9 +1,17 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: robotframework-testdoc
3
- Version: 0.2.0
3
+ Version: 0.2.3
4
4
  Summary: A CLI Tool to generate a Test Documentation for your RobotFramework Test Scripts.
5
5
  Author-email: Marvin Klerx <marvinklerx20@gmail.com>
6
- License: MIT
6
+ License: Apache-2.0
7
+ Project-URL: Repository, https://github.com/MarvKler/robotframework-testdoc
8
+ Project-URL: Issues, https://github.com/MarvKler/robotframework-testdoc/issues
9
+ Classifier: Development Status :: 4 - Beta
10
+ Classifier: Programming Language :: Python
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
7
15
  Requires-Python: >=3.7
8
16
  Description-Content-Type: text/markdown
9
17
  License-File: LICENSE
@@ -15,11 +23,17 @@ Dynamic: license-file
15
23
 
16
24
  # Robot Framework TestDoc
17
25
 
26
+ ## GitHub Project
27
+
28
+ Link to GitHub Project: [robotframework-testdoc](https://github.com/MarvKler/robotframework-testdoc)
29
+
18
30
  ## Statistics
19
31
 
20
- [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
21
- [![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
22
- [![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
32
+ [![Release Pipeline](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml/badge.svg)](https://github.com/MarvKler/robotframework-testdoc/actions/workflows/release.yml)
33
+ [![PyPI - Version](https://img.shields.io/pypi/v/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)
34
+ [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/robotframework-testdoc.svg)](https://pypi.org/project/robotframework-testdoc)
35
+ [![PyPI Downloads - Total](https://static.pepy.tech/badge/robotframework-testdoc)](https://pepy.tech/projects/robotframework-testdoc)
36
+ [![PyPI Downloads - Monthly](https://static.pepy.tech/badge/robotframework-testdoc/month)](https://pepy.tech/projects/robotframework-testdoc)
23
37
 
24
38
  ## Installation
25
39
 
{robotframework_testdoc-0.2.0 → robotframework_testdoc-0.2.3}/src/robotframework_testdoc.egg-info/SOURCES.txt RENAMED
@@ -2,7 +2,7 @@
2
2
  LICENSE
3
3
  README.md
4
4
  pyproject.toml
5
- .github/workflows/build-publish.yml
5
+ .github/workflows/build.yml
6
6
  .github/workflows/release.yml
7
7
  atest/test_cli.py
8
8
  atest/test_cli.robot