strictdoc 0.8.0__tar.gz → 0.9.0__tar.gz

{strictdoc-0.8.0 → strictdoc-0.9.0}/NOTICE

@@ -21,26 +21,27 @@ LICENSE file for more information.
 Contributors
 ------------
 
-Please visit: https://strictdoc.readthedocs.io/en/latest/strictdoc_30_credits.html.
+Please visit: https://strictdoc.readthedocs.io/en/latest/latest/docs/strictdoc_30_credits.html.
 
 Third-party libraries and tools used in this project
 ----------------------------------------------------
 
 - textX, MIT License, https://github.com/textX/textX/blob/master/LICENSE.txt
-- Sphinx, The 2-clause BSD License, https://github.com/sphinx-doc/sphinx/blob/master/LICENSE
+- Sphinx, The 2-clause BSD License, https://github.com/sphinx-doc/sphinx/blob/master/LICENSE.rst
 - Docutils, Public Domain Dedication with exceptions, https://docutils.sourceforge.io/COPYING.html
 - reqif, Apache 2 License, https://github.com/strictdoc-project/reqif/blob/main/LICENSE
 - lxml, The 3-Clause BSD License, https://github.com/lxml/lxml/blob/master/doc/licenses/BSD.txt
 - FastAPI, MIT License, https://github.com/tiangolo/fastapi/blob/master/LICENSE
 - Turbo.js, MIT License, https://github.com/hotwired/turbo/blob/main/MIT-LICENSE
 - Stimulus.js, MIT License, https://github.com/hotwired/stimulus/blob/main/LICENSE.md
-- Jinja, BSD 3-Clause "New" or "Revised" License, https://github.com/pallets/jinja/blob/main/LICENSE.rst
+- Jinja, BSD 3-Clause "New" or "Revised" License, https://github.com/pallets/jinja/blob/main/LICENSE.txt
 - Pygments, BSD 2-Clause "Simplified" License, https://github.com/pygments/pygments/blob/master/LICENSE
 - XlsxWriter, BSD 2-Clause "Simplified" License, https://github.com/jmcnamara/XlsxWriter/blob/main/LICENSE.txt
 - xlrd, The 3-Clause BSD License and another license for earlier work, https://github.com/python-excel/xlrd/blob/master/LICENSE
 - python-datauri, The Unlicense, https://github.com/fcurella/python-datauri/blob/master/LICENSE
+- tree-sitter, MIT License, https://github.com/tree-sitter/tree-sitter/blob/master/LICENSE
 
-Please also visit: https://strictdoc.readthedocs.io/en/latest/strictdoc_30_credits.html.
+Please also visit: https://strictdoc.readthedocs.io/en/latest/latest/docs/strictdoc_30_credits.html.
 
 Contact
 -------

{strictdoc-0.8.0 → strictdoc-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: strictdoc
-Version: 0.8.0
+Version: 0.9.0
 Summary: StrictDoc is open-source software for technical documentation and requirements management.
 Project-URL: Changelog, https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md
 Project-URL: Homepage, https://strictdoc.readthedocs.io/en/stable/
@@ -9,27 +9,31 @@ Author-email: Stanislav Pankevich <s.pankevich@gmail.com>, Maryna Balioura <mett
 License-Expression: Apache-2.0
 License-File: LICENSE
 License-File: NOTICE
-Classifier: License :: OSI Approved :: BSD License
+Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
 Requires-Python: >=3.8
 Requires-Dist: beautifulsoup4==4.*,>=4.12.0
 Requires-Dist: docutils==0.*,>=0.16
 Requires-Dist: fastapi>=0.83.0
-Requires-Dist: html2print>=0.0.15
+Requires-Dist: html2pdf4doc>=0.0.18
 Requires-Dist: html5lib>=1.1
 Requires-Dist: jinja2>=2.11.2
+Requires-Dist: lark>=1.2.2
 Requires-Dist: openpyxl>=3.1.0
 Requires-Dist: pygments==2.*,>=2.10.0
 Requires-Dist: python-datauri==2.*,>=2.1.1
 Requires-Dist: python-multipart
 Requires-Dist: reqif==0.*,>=0.0.39
+Requires-Dist: robotframework>=4.0.0
 Requires-Dist: spdx-tools
 Requires-Dist: textx==4.*,>=4.0.0
 Requires-Dist: toml
@@ -50,9 +54,5 @@ Description-Content-Type: text/markdown
 
 # StrictDoc
 
-![](https://github.com/stanislaw/strictdoc/actions/workflows/ci-mac.yml/badge.svg)
-![](https://github.com/stanislaw/strictdoc/actions/workflows/ci-linux-ubuntu-latest.yml/badge.svg)
-![](https://github.com/stanislaw/strictdoc/actions/workflows/ci-windows.yml/badge.svg)
-
 The documentation is hosted on Read the Docs:
 [StrictDoc documentation](https://strictdoc.readthedocs.io/en/stable/).

strictdoc-0.9.0/README.md

@@ -0,0 +1,4 @@
+# StrictDoc
+
+The documentation is hosted on Read the Docs:
+[StrictDoc documentation](https://strictdoc.readthedocs.io/en/stable/).

{strictdoc-0.8.0 → strictdoc-0.9.0}/pyproject.toml

@@ -31,24 +31,24 @@ authors = [
     { name = "Maryna Balioura", email = "mettta@gmail.com" },
 ]
 classifiers = [
-    # "Development Status :: 4 - Beta",
-    # "Environment :: Web Environment",
-    # "Intended Audience :: Developers",
-    "License :: OSI Approved :: BSD License",
+    "License :: OSI Approved :: Apache Software License",
     "Operating System :: OS Independent",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
     "Programming Language :: Python :: Implementation :: CPython",
     "Programming Language :: Python :: Implementation :: PyPy",
-    # "Topic :: Internet :: WWW/HTTP",
 ]
 
 # @sdoc[SDOC-SRS-89]
 dependencies = [
     "textx >= 4.0.0, == 4.*",
+    "lark >= 1.2.2",
+
     "jinja2 >= 2.11.2",
     # Reading project config from strictdoc.toml file.
     "toml",
@@ -88,7 +88,10 @@ dependencies = [
     "WebSockets",
 
     # HTML2PDF dependencies
-    "html2print >= 0.0.15",
+    "html2pdf4doc >= 0.0.18",
+
+    # Robot Framework dependencies
+    "robotframework >= 4.0.0",
 ]
 # @sdoc[/SDOC-SRS-89]
 
@@ -110,7 +113,6 @@ strictdoc = "strictdoc.cli.main:main"
 
 [project.urls]
 Changelog = "https://github.com/strictdoc-project/strictdoc/blob/main/CHANGELOG.md"
-# Funding = "https://..."
 Homepage = "https://strictdoc.readthedocs.io/en/stable/"
 Source = "https://github.com/strictdoc-project/strictdoc"
 
@@ -119,3 +121,14 @@ addopts = "--import-mode=importlib"
 pythonpath = [
   "."
 ]
+
+[tool.fixit]
+enable = [
+    ".developer.fixit.check_comments",
+    ".developer.fixit.check_docstrings",
+]
+
+# FIXME: Remove disable.
+disable = [
+    "fixit.rules"
+]

{strictdoc-0.8.0 → strictdoc-0.9.0}/strictdoc/__init__.py

@@ -1,6 +1,6 @@
 from strictdoc.core.environment import SDocRuntimeEnvironment
 
-__version__ = "0.8.0"
+__version__ = "0.9.0"
 
 
 environment = SDocRuntimeEnvironment(__file__)

{strictdoc-0.8.0 → strictdoc-0.9.0}/strictdoc/backend/excel/export/excel_generator.py

@@ -1,4 +1,4 @@
-# mypy: disable-error-code="arg-type,no-untyped-def,type-arg,union-attr,var-annotated"
+# mypy: disable-error-code="arg-type,no-untyped-def,union-attr"
 import os
 from pathlib import Path
 from typing import Dict, List
@@ -8,6 +8,7 @@ from xlsxwriter.workbook import Workbook
 from xlsxwriter.worksheet import Worksheet
 
 from strictdoc.backend.sdoc.models.document import SDocDocument
+from strictdoc.backend.sdoc.models.model import SDocElementIF
 from strictdoc.backend.sdoc.models.node import SDocNode
 from strictdoc.backend.sdoc.models.reference import (
     FileReference,
@@ -73,31 +74,41 @@ class ExcelGenerator:
                 }
             )
 
-            row = 1  # Header-Row
+            # Header row.
+            row = 1
+
             fields = project_config.excel_export_fields
-            # TODO: Check if all fields are defined by the DocumentGrammar
+
+            # FIXME: Check if all fields are defined by the DocumentGrammar.
             columns = ExcelGenerator._init_columns_width(fields)
 
-            req_uid_rows = ExcelGenerator._lookup_refs(
-                traceability_index.get_document_iterator(document).all_content(
-                    print_fragments=False, print_fragments_from_files=False
+            document_iterator = traceability_index.get_document_iterator(
+                document
+            )
+            all_nodes = list(
+                map(
+                    lambda node_with_context_: node_with_context_[0],
+                    document_iterator.all_content(
+                        print_fragments=False, print_fragments_from_files=False
+                    ),
                 )
             )
+            req_uid_rows = ExcelGenerator._lookup_refs(all_nodes)
 
             if len(req_uid_rows):
-                for node in traceability_index.get_document_iterator(
+                for node, _ in traceability_index.get_document_iterator(
                     document
                 ).all_content(
                     print_fragments=False, print_fragments_from_files=False
                 ):
-                    if not node.is_requirement or not node.reserved_uid:
-                        # only export the requirements with uid
+                    if not node.is_requirement() or not node.reserved_uid:
+                        # Only export the requirements with UID.
                         continue
 
                     for idx, field in enumerate(fields, start=0):
                         field_uc = field.upper()
 
-                        # Special treatment for ParentReqReference and Comments
+                        # Special treatment for ParentReqReference and Comments.
                         if field_uc in (
                             "RELATIONS:PARENT",
                             "PARENT",
@@ -107,7 +118,7 @@ class ExcelGenerator:
                                 ReferenceType.PARENT
                             )
                             if len(parent_refs) > 0:
-                                # TODO Allow multiple parent refs
+                                # FIXME: Allow multiple parent refs.
                                 ref = parent_refs[0]
                                 columns[field][MAX_WIDTH_KEY] = max(
                                     len(ref.ref_uid),
@@ -128,7 +139,7 @@ class ExcelGenerator:
                                     worksheet.write(row, idx, ref.ref_uid)
                         elif field_uc in ("COMMENT", "COMMENTS"):
                             # Using a transition marker to separate multiple
-                            # comments
+                            # comments.
                             comment_fields = node.get_comment_fields()
                             if len(comment_fields) > 0:
                                 comment_row_value: str = ""
@@ -151,7 +162,7 @@ class ExcelGenerator:
                             if len(node.relations) > 0:
                                 relations_components = []
                                 # Using a transition marker to separate
-                                # multiple references
+                                # multiple references.
                                 for ref in node.relations:
                                     if isinstance(ref, ParentReqReference):
                                         relations_components.append(
@@ -200,8 +211,8 @@ class ExcelGenerator:
 
                     row += 1
 
-                # add a table around all this data, allowing filtering and
-                # ordering in Excel
+                # Add a table around all this data, allowing filtering and
+                # ordering in Excel.
                 worksheet.add_table(
                     0,
                     0,
@@ -210,12 +221,12 @@ class ExcelGenerator:
                     {"columns": ExcelGenerator._init_headers(fields)},
                 )
 
-                # enforce columns width
+                # Enforce columns width.
                 ExcelGenerator._set_columns_width(
                     workbook, worksheet, columns, fields
                 )
             else:
-                # no requirement with UID
+                # No requirement with UID.
                 print(  # noqa: T201
                     "No requirement with UID, nothing to export into excel"
                 )
@@ -224,14 +235,14 @@ class ExcelGenerator:
             os.unlink(document_out_file)
 
     @staticmethod
-    def _lookup_refs(document_contents: List) -> Dict[str, int]:
+    def _lookup_refs(document_contents: List[SDocElementIF]) -> Dict[str, int]:
         refs: Dict[str, int] = {}
         row = 1
 
         for content_node in document_contents:
             if isinstance(content_node, SDocNode):
                 if content_node.reserved_uid:
-                    # only export the requirements with uid, allowing tracking
+                    # Only export the requirements with uid, allowing tracking.
                     row += 1
                     refs[content_node.reserved_uid] = row
 
@@ -239,7 +250,7 @@ class ExcelGenerator:
 
     @staticmethod
     def _init_columns_width(fields: List[str]):
-        columns = {}
+        columns: Dict[str, Dict[str, int]] = {}
 
         for field in fields:
             columns[field] = {}
@@ -260,8 +271,8 @@ class ExcelGenerator:
                 worksheet.set_column(idx, idx, columns[field][MAX_WIDTH_KEY])
 
     @staticmethod
-    def _init_headers(fields: List[str]) -> List:
-        headers: List = []
+    def _init_headers(fields: List[str]) -> List[str]:
+        headers: List[str] = []
 
         for field in fields:
             headers.append({"header": field.upper()})

{strictdoc-0.8.0 → strictdoc-0.9.0}/strictdoc/backend/excel/import_/excel_sheet_proxy.py

@@ -14,7 +14,9 @@ class ExcelLibType(Enum):
 
 @auto_described
 class ExcelSheetProxy:
-    """This proxy class allows to open either xls(xlrd) or xlsx(openpyxl) with the same interface"""
+    """
+    This proxy class allows to open either xls(xlrd) or xlsx(openpyxl) with the same interface.
+    """
 
     def __init__(self, file: str):
         self.file = file
@@ -35,7 +37,9 @@ class ExcelSheetProxy:
 
     @property
     def name(self) -> str:
-        """returns the name of the first sheet"""
+        """
+        Returns the name of the first sheet.
+        """
         if self.lib == ExcelLibType.OPENPYXL:
             return str(self.sheet.title)
         elif self.lib == ExcelLibType.XLRD:
@@ -44,7 +48,9 @@ class ExcelSheetProxy:
 
     @property
     def ncols(self) -> int:
-        """the number of columns"""
+        """
+        The number of columns.
+        """
         ncols: int = 0
         if self.lib == ExcelLibType.OPENPYXL:
             ncols = self.sheet.max_column
@@ -54,7 +60,9 @@ class ExcelSheetProxy:
 
     @property
     def nrows(self) -> int:
-        """the number of rows"""
+        """
+        The number of rows.
+        """
         nrows: int = 0
         if self.lib == ExcelLibType.OPENPYXL:
             nrows = self.sheet.max_row
@@ -63,7 +71,9 @@ class ExcelSheetProxy:
         return nrows
 
     def get_cell_value(self, row: int, col: int) -> str:
-        """returns the value at row/col as string"""
+        """
+        Returns the value at row/col as string.
+        """
         cell_value: str = ""
         if self.lib == ExcelLibType.OPENPYXL:
             cell_value = (
@@ -74,7 +84,9 @@ class ExcelSheetProxy:
         return cell_value
 
     def row_values(self, row: int) -> List[str]:
-        """returns a full row as list"""
+        """
+        Returns a full row as list.
+        """
         row_values: List[str] = []
         if self.lib == ExcelLibType.OPENPYXL:
             row_values = [(cell.value or "") for cell in self.sheet[row + 1]]

{strictdoc-0.8.0 → strictdoc-0.9.0}/strictdoc/backend/excel/import_/excel_to_sdoc_converter.py

@@ -40,10 +40,14 @@ def safe_name(dangerous_name):
 
 class ExcelToSDocConverter:
     @staticmethod
-    # optional argument title is present for external scripts to assign a title
     def convert(
         excel_file: str, title: Union[str, None] = None
     ) -> SDocDocument:
+        """
+        Convert a provided Excel file to an SDoc document.
+
+        Optional argument title is present for external scripts to assign a title.
+        """
         sheet = ExcelSheetProxy(excel_file)
 
         excel_file_name = os.path.basename(excel_file)
@@ -52,12 +56,13 @@ class ExcelToSDocConverter:
 
         all_header_columns = list(range(sheet.ncols))
 
-        for i in range(16):  # the first 16 rows should do ¯\_(ツ)_/¯
+        # The first 16 rows should do ¯\_(ツ)_/¯.
+        for i in range(16):
             if sheet.row_values(i)[0].strip() != "":
                 header_row_idx = i
                 break
         else:
-            raise NotImplementedError
+            raise NotImplementedError  # pragma: no cover
 
         header_row = sheet.row_values(header_row_idx)
         safe_header_row = [safe_name(x) for x in header_row]
@@ -149,7 +154,13 @@ class ExcelToSDocConverter:
             )
 
         requirements_element = GrammarElement(
-            parent=None, tag="REQUIREMENT", fields=fields, relations=[]
+            parent=None,
+            tag="REQUIREMENT",
+            property_is_composite="",
+            property_prefix="",
+            property_view_style="",
+            fields=fields,
+            relations=[],
         )
         elements = [requirements_element]
         grammar = DocumentGrammar(parent=document, elements=elements)