reftable 1.0.0__tar.gz

reftable-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Helmut Konrad Schewe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

reftable-1.0.0/PKG-INFO

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: reftable
+Version: 1.0.0
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/reftable
+Project-URL: Repository, https://github.com/anaticulae/reftable
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: configos<2.0.0,>=1.0.4
+Requires-Dist: elementae<2.0.0,>=1.0.1
+Requires-Dist: geostrat<2.0.0,>=1.5.1
+Requires-Dist: iamraw<5.0.0,>=4.92.0
+Requires-Dist: utilo<3.0.0,>=2.109.1
+Provides-Extra: dev
+Requires-Dist: capita-ref<2.0.0,>=1.0.1; extra == "dev"
+Requires-Dist: capita<2.0.0,>=1.25.3; extra == "dev"
+Requires-Dist: cleanup<2.0.0,>=1.0.4; extra == "dev"
+Requires-Dist: gennex==1.0.3; extra == "dev"
+Requires-Dist: groupmes==1.1.0; extra == "dev"
+Requires-Dist: headnote==1.0.3; extra == "dev"
+Requires-Dist: hoverpower==1.5.2; extra == "dev"
+Requires-Dist: ibidem==1.0.2; extra == "dev"
+Requires-Dist: pagenumber==1.0.0; extra == "dev"
+Requires-Dist: rawmaker==2.40.5; extra == "dev"
+Requires-Dist: utilotest==1.0.4; extra == "dev"
+Dynamic: license-file
+
+# reftable

reftable-1.0.0/README

@@ -0,0 +1 @@
+# reftable

reftable-1.0.0/pyproject.toml

@@ -0,0 +1,116 @@
+[project]
+name = "reftable"
+version = "1.0.0"
+description = ""
+requires-python = ">=3.12"
+authors = [
+    { name = "Helmut Konrad Schewe", email = "helmutus@outlook.com" },
+]
+dependencies = [
+    "configos>=1.0.4,<2.0.0",
+    "elementae>=1.0.1,<2.0.0",
+    "geostrat>=1.5.1,<2.0.0",
+    "iamraw>=4.92.0,<5.0.0",
+    "utilo>=2.109.1,<3.0.0",
+]
+keywords = []
+classifiers = [
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+license = "MIT"
+license-files = [
+    "LICENSE",
+]
+
+[project.readme]
+file = "README"
+content-type = "text/markdown"
+
+[project.optional-dependencies]
+dev = [
+    "capita-ref>=1.0.1,<2.0.0",
+    "capita>=1.25.3,<2.0.0",
+    "cleanup>=1.0.4,<2.0.0",
+    "gennex==1.0.3",
+    "groupmes==1.1.0",
+    "headnote==1.0.3",
+    "hoverpower==1.5.2",
+    "ibidem==1.0.2",
+    "pagenumber==1.0.0",
+    "rawmaker==2.40.5",
+    "utilotest==1.0.4",
+]
+
+[project.urls]
+Homepage = "https://github.com/anaticulae/reftable"
+Repository = "https://github.com/anaticulae/reftable"
+
+[project.scripts]
+reftable = "reftable.cli:main"
+
+[build-system]
+requires = [
+    "setuptools>=83.0.0",
+    "wheel>=0.47.0",
+]
+build-backend = "setuptools.build_meta"
+
+[tool.semantic_release]
+version_toml = [
+    "pyproject.toml:project.version",
+]
+
+[tool.semantic_release.changelog]
+mode = "init"
+output_format = "md"
+
+[tool.semantic_release.changelog.default_templates]
+changelog_file = "CHANGELOG"
+
+[tool.semantic_release.commit_parser_options]
+patch_tags = [
+    "build",
+    "chore",
+    "ci",
+    "deps",
+    "docs",
+    "fix",
+    "perf",
+    "refactor",
+    "style",
+    "test",
+]
+minor_tags = [
+    "feat",
+]
+
+[tool.setuptools.packages.find]
+where = [
+    ".",
+]
+include = [
+    "reftable",
+    "reftable.abbrev",
+    "reftable.feature",
+    "reftable.figure",
+    "reftable.toc",
+    "reftable.toc.basic",
+    "reftable.toc.strategy",
+]
+exclude = [
+    "tests*",
+]
+
+[tool.hoverpower]
+packages = [
+    "BACHELOR",
+    "BOOK",
+    "DISS",
+    "DOCU",
+    "HOME",
+    "MASTER",
+    "PAPER",
+    "TECH",
+]

reftable-1.0.0/reftable/__init__.py

@@ -0,0 +1,19 @@
+#==============================================================================
+# C O P Y R I G H T
+#------------------------------------------------------------------------------
+# Copyright (c) 2022-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+#==============================================================================
+
+import importlib.metadata
+import os
+
+import reftable.path
+
+PROCESS = 'reftable'
+
+__version__ = importlib.metadata.version(PROCESS)
+
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))

reftable-1.0.0/reftable/__main__.py

@@ -0,0 +1,13 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2022-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+from reftable.cli import main
+
+if __name__ == "__main__":
+    main()

reftable-1.0.0/reftable/abbrev/__init__.py

@@ -0,0 +1,41 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Abbreviation
+============
+
+Examples:
+
+* homework/page_50_math.pdf:page6
+* master/page_116_images_toc_formular.pdf:95
+
+TODO: Abbreviation creation tool
+TODO: Symbol collector
+"""
+
+import abc
+import dataclasses
+
+import iamraw
+import texmex
+
+
+@dataclasses.dataclass
+class AbbreviationData:
+    normal: texmex.PTNs = None
+    oneline: texmex.PTNs = None
+
+
+class AbbreviationExtractorStrategy(abc.ABC):
+
+    def __init__(self, loaded: AbbreviationData):
+        self.loaded = loaded
+
+    @abc.abstractmethod
+    def result(self) -> iamraw.AbbreviationResult:
+        pass

reftable-1.0.0/reftable/abbrev/geometry.py

@@ -0,0 +1,69 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Abbreviation Parser: Geometry Strategy
+======================================
+
+This approach splits the page in two columns and detect a left shortcut
+and a right description column. It is required that the distance between
+left and right column is not ?too? tight.
+
+Working Examples
+----------------
+
+* bachelor37: page 2
+
+Not working
+-----------
+
+* homework50: columns are to tight together
+
+Nearly working
+--------------
+
+* master116: improve layout parser
+"""
+
+import geostrat
+import iamraw
+import texmex
+import utilo
+
+import reftable.abbrev
+
+
+class GeometryAbbreviationParser(reftable.abbrev.AbbreviationExtractorStrategy):
+
+    def result(self) -> iamraw.AbbreviationResult:
+        ready = iamraw.AbbreviationResult()
+        for page in self.loaded.normal:
+            parsed = parse_page(page)
+            if parsed is None:
+                utilo.info(f'could not parse page: {page.page}')
+                continue
+            for item in parsed:
+                ready.append(item)
+            ready.pdfpages.append(page.page)
+        return ready
+
+
+def parse_page(page: texmex.PTN) -> iamraw.Abbreviations:
+    parsed = geostrat.dc_parse_page(page)
+    if not parsed:
+        return None
+    result = []
+    for short, description in parsed:
+        short, description = short.strip(), description.strip()
+        description = description.lstrip('-')
+        result.append(
+            iamraw.Abbreviation(
+                short=short,
+                description=description,
+                position=iamraw.AbbreviationPosition(page=page.page),
+            ))
+    return result

reftable-1.0.0/reftable/abbrev/parser.py

@@ -0,0 +1,36 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import iamraw
+
+import reftable.abbrev
+import reftable.abbrev.geometry
+import reftable.abbrev.simple
+
+STRATEGIES = [
+    reftable.abbrev.simple.SimpleAbbreviationParser,
+    reftable.abbrev.geometry.GeometryAbbreviationParser,
+]
+
+
+def parse(data: reftable.abbrev.AbbreviationData) -> iamraw.AbbreviationResult:
+    assert isinstance(data.normal, list), type(data)
+    assert isinstance(data.oneline, list), type(data)
+    parsed = [strategy(data).result() for strategy in STRATEGIES]
+    judged = judge(parsed)
+    return judged
+
+
+def judge(results) -> iamraw.AbbreviationResult:
+    simple = results[0]
+    geometry = results[1]
+    more_than_double_parsed = (len(geometry) * 2) < len(simple)
+    if more_than_double_parsed:
+        return simple
+    return geometry

reftable-1.0.0/reftable/abbrev/simple.py

@@ -0,0 +1,66 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import elementae.headline.lookup
+import iamraw
+import utilo
+
+import reftable.abbrev
+
+
+class SimpleAbbreviationParser(reftable.abbrev.AbbreviationExtractorStrategy):
+
+    def result(self) -> iamraw.AbbreviationResult:
+        ready = iamraw.AbbreviationResult()
+        for page in self.loaded.oneline:
+            parsed = parse_page(page)
+            for item in parsed:
+                ready.append(item)
+            if parsed:
+                ready.pdfpages.append(page.page)
+        return ready
+
+
+def parse_page(content):
+    result = []
+    for line in content:
+        raw = line.text
+        utilo.debug(f'parse: {raw}')
+        try:
+            short, description = raw.split(maxsplit=1)
+        except ValueError:
+            if not isexcluded(raw):
+                utilo.debug(f'could not parse abbreviation: {raw}')
+            continue
+        if isexcluded(short) or isexcluded(description):
+            utilo.info(f'skip: {short}, {description}')
+            continue
+        short, description = short.strip(), description.strip()
+        parsed = iamraw.Abbreviation(
+            short=short,
+            description=description,
+        )
+        utilo.debug(f'parsed: {parsed}')
+        result.append(parsed)
+    return result
+
+
+def isexcluded(item: str) -> bool:
+    # TODO: ADD MORE SOPHISTICATED DOUBLE COLUMN CHECKER
+    item = item.strip().lower()
+    if item in elementae.headline.lookup.HEADLINES:
+        return True
+    if item in NO_ABBREVIATION:
+        return True
+    return False
+
+
+NO_ABBREVIATION = utilo.splitlines("""\
+BESCHREIBUNG
+""")

reftable-1.0.0/reftable/cli.py

@@ -0,0 +1,76 @@
+#==============================================================================
+# C O P Y R I G H T
+#------------------------------------------------------------------------------
+# Copyright (c) 2019-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+#==============================================================================
+
+import utilo
+
+import reftable
+
+DESCRIPTION = ''
+
+WORKPLAN = [
+    utilo.create_step(
+        'abbrev',
+        inputs=[
+            utilo.ResultFile(producer='rawmaker', name='text_text'),
+            utilo.ResultFile(producer='rawmaker', name='text_positions'),
+            utilo.ResultFile(producer='rawmaker', name='oneline_text_text'),
+            utilo.ResultFile('rawmaker', name='oneline_text_positions'),
+            utilo.ResultFile(producer='groupme', name='footer_footerheader'),
+            utilo.ResultFile(producer='rawmaker', name='border_pages'),
+        ],
+        output=('abbrev',),
+    ),
+    utilo.create_step(
+        'toc',
+        inputs=[
+            utilo.ResultFile(producer='rawmaker', name='oneline_text_text'),
+            utilo.ResultFile('rawmaker', name='oneline_text_positions'),
+            utilo.ResultFile(producer='groupme', name='footer_footerheader'),
+            utilo.ResultFile(producer='rawmaker', name='border_pages'),
+        ],
+        output=('toc',),
+    ),
+    utilo.create_step(
+        'figure',
+        inputs=[
+            utilo.ResultFile(producer='rawmaker', name='text_text'),
+            utilo.ResultFile(producer='rawmaker', name='text_positions'),
+            utilo.ResultFile(producer='rawmaker', name='oneline_text_text'),
+            utilo.ResultFile('rawmaker', name='oneline_text_positions'),
+            utilo.ResultFile(producer='groupme', name='footer_footerheader'),
+            utilo.ResultFile(producer='rawmaker', name='border_pages'),
+        ],
+        output=('figure',),
+    ),
+    utilo.create_step(
+        'table',
+        inputs=[
+            utilo.ResultFile(producer='rawmaker', name='oneline_text_text'),
+            utilo.ResultFile('rawmaker', name='oneline_text_positions'),
+            utilo.ResultFile(producer='groupme', name='footer_footerheader'),
+            utilo.ResultFile(producer='rawmaker', name='border_pages'),
+        ],
+        output=('table',),
+    ),
+]
+
+
+def main():
+    utilo.featurepack(
+        workplan=WORKPLAN,
+        root=reftable.ROOT,
+        featurepackage='reftable.feature',
+        config=utilo.FeaturePackConfig(
+            description=DESCRIPTION,
+            multiprocessed=True,
+            name=reftable.PROCESS,
+            pages=True,
+            version=reftable.__version__,
+        ),
+    )

reftable-1.0.0/reftable/feature/__init__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2022-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================

reftable-1.0.0/reftable/feature/abbrev.py

@@ -0,0 +1,67 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2020-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+
+import serializeraw
+
+import reftable.abbrev
+import reftable.abbrev.parser
+
+
+def work(
+    text: str,
+    textposition: str,
+    text_oneline: str,
+    textposition_oneline: str,
+    headerfooter: str,
+    sizeandborder: str,
+    pages: tuple = None,
+) -> str:
+    data = load_data(
+        text,
+        textposition,
+        text_oneline,
+        textposition_oneline,
+        headerfooter,
+        sizeandborder,
+        pages,
+    )
+    parsed = reftable.abbrev.parser.parse(data)
+    # dump result
+    dumped = serializeraw.dump_abbreviation_table(parsed)
+    return dumped
+
+
+def load_data(
+    text: str,
+    textposition: str,
+    text_oneline: str,
+    textposition_oneline: str,
+    headerfooter: str,
+    sizeandborder: str,
+    pages: tuple = None,
+) -> reftable.abbrev.AbbreviationData:
+    normal = serializeraw.ptcn_fromfile(
+        text=text,
+        textpositions=textposition,
+        sizeandborder=sizeandborder,
+        headerfooter=headerfooter,
+        pages=pages,
+    )
+    oneline = serializeraw.ptcn_fromfile(
+        text=text_oneline,
+        textpositions=textposition_oneline,
+        sizeandborder=sizeandborder,
+        headerfooter=headerfooter,
+        pages=pages,
+    )
+    data = reftable.abbrev.AbbreviationData(
+        normal=normal,
+        oneline=oneline,
+    )
+    return data

reftable-1.0.0/reftable/feature/figure.py

@@ -0,0 +1,51 @@
+# =============================================================================
+# C O P Y R I G H T
+# -----------------------------------------------------------------------------
+# Copyright (c) 2019-2023 by Helmut Konrad Schewe. All rights reserved.
+# This file is property of Helmut Konrad Schewe. Any unauthorized copy,
+# use or distribution is an offensive act against international law and may
+# be prosecuted under federal law. Its content is company confidential.
+# =============================================================================
+"""Table of figures extractor
+==========================
+"""
+
+import serializeraw
+
+import reftable.figure.strategy
+
+
+def work(
+    text: str,
+    textpositions: str,
+    oneline_text: str,
+    oneline_textpositions: str,
+    headerfooter: str,
+    sizeandborder: str,
+    pages: tuple = None,
+) -> str:
+    """Extract table of figures out of `document`.
+
+    Args:
+        text(str): path to load document
+        textpositions(str): path to load document textpositions
+        oneline_text(str): oneline document
+        oneline_textpositions(str): oneline document positions
+        headerfooter(str): path with header and footer to determine
+                           content border.
+        sizeandborder(str): path with page sizes and content border
+        pages(tuple): tuple of selected pages
+    Returns:
+        dump of extracted table of content
+    """
+    result = reftable.figure.strategy.run(
+        text=text,
+        textpositions=textpositions,
+        oneline_text=oneline_text,
+        oneline_textpositions=oneline_textpositions,
+        headerfooter=headerfooter,
+        sizeandborder=sizeandborder,
+        pages=pages,
+    )
+    dumped = serializeraw.dump_toc(result)
+    return dumped