queuemo 1.27.6__tar.gz

queuemo-1.27.6/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.

queuemo-1.27.6/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: queuemo
+Version: 1.27.6
+Author-email: Helmut Konrad Schewe <helmutus@outlook.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/anaticulae/queuemo
+Project-URL: Repository, https://github.com/anaticulae/queuemo
+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: analp<2.0.0,>=1.1.0
+Requires-Dist: bibliographia<2.0.0,>=1.0.1
+Requires-Dist: callidus<2.0.0,>=1.7.1
+Requires-Dist: capita<2.0.0,>=1.25.3
+Requires-Dist: captions<2.0.0,>=1.0.1
+Requires-Dist: codero<2.0.0,>=1.0.1
+Requires-Dist: configos<2.0.0,>=1.0.4
+Requires-Dist: decider-chapter<2.0.0,>=1.0.2
+Requires-Dist: decider-con<2.0.0,>=1.0.1
+Requires-Dist: decider-lay<2.0.0,>=1.0.0
+Requires-Dist: decider-main<4.0.0,>=3.4.3
+Requires-Dist: decider-ref<2.0.0,>=1.22.2
+Requires-Dist: figureo<2.0.0,>=1.0.1
+Requires-Dist: flask<4.0.0,>=3.1.3
+Requires-Dist: groupmes<2.0.0,>=1.1.3
+Requires-Dist: headnote<2.0.0,>=1.0.3
+Requires-Dist: ibidem<2.0.0,>=1.0.2
+Requires-Dist: indagator<2.0.0,>=1.0.2
+Requires-Dist: indicibus<2.0.0,>=1.0.2
+Requires-Dist: layouta<2.0.0,>=1.1.0
+Requires-Dist: mundare<2.0.0,>=1.0.2
+Requires-Dist: pagenumber<2.0.0,>=1.0.0
+Requires-Dist: pdflog<2.0.0,>=1.0.2
+Requires-Dist: qvlink<3.0.0,>=2.15.7
+Requires-Dist: rawmaker<3.0.0,>=2.40.5
+Requires-Dist: reftable<2.0.0,>=1.0.0
+Requires-Dist: responsio<2.0.0,>=1.15.6
+Requires-Dist: tablero<2.0.0,>=1.0.1
+Requires-Dist: titulum<2.0.0,>=1.0.2
+Requires-Dist: ughost<2.0.0,>=1.1.1
+Requires-Dist: utilo<3.0.0,>=2.112.1
+Requires-Dist: verbo<2.0.0,>=1.23.4
+Provides-Extra: dev
+Requires-Dist: gennex==1.1.0; extra == "dev"
+Requires-Dist: hoverpower==1.7.0; extra == "dev"
+Requires-Dist: utilotest==1.1.1; extra == "dev"
+Dynamic: license-file
+
+# queuemo
+
+The back-end does the work. The back-end waits for new PDFs in a common file
+space, after a new pdf arrives, the algorithms start there work. The plan how
+to work is defined in `recipes`.
+
+Features:
+
+* recipes
+* publishing

queuemo-1.27.6/README

@@ -0,0 +1,10 @@
+# queuemo
+
+The back-end does the work. The back-end waits for new PDFs in a common file
+space, after a new pdf arrives, the algorithms start there work. The plan how
+to work is defined in `recipes`.
+
+Features:
+
+* recipes
+* publishing

queuemo-1.27.6/pyproject.toml

@@ -0,0 +1,136 @@
+[build-system]
+requires = [
+    "setuptools>=83.0.0",
+    "wheel>=0.47.0",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "queuemo"
+version = "1.27.6"
+description = ""
+requires-python = ">=3.12"
+authors = [
+    { name = "Helmut Konrad Schewe", email = "helmutus@outlook.com" },
+]
+dependencies = [
+    "analp>=1.1.0,<2.0.0",
+    "bibliographia>=1.0.1,<2.0.0",
+    "callidus>=1.7.1,<2.0.0",
+    "capita>=1.25.3,<2.0.0",
+    "captions>=1.0.1,<2.0.0",
+    "codero>=1.0.1,<2.0.0",
+    "configos>=1.0.4,<2.0.0",
+    "decider-chapter>=1.0.2,<2.0.0",
+    "decider-con>=1.0.1,<2.0.0",
+    "decider-lay>=1.0.0,<2.0.0",
+    "decider-main>=3.4.3,<4.0.0",
+    "decider-ref>=1.22.2,<2.0.0",
+    "figureo>=1.0.1,<2.0.0",
+    "flask>=3.1.3,<4.0.0",
+    "groupmes>=1.1.3,<2.0.0",
+    "headnote>=1.0.3,<2.0.0",
+    "ibidem>=1.0.2,<2.0.0",
+    "indagator>=1.0.2,<2.0.0",
+    "indicibus>=1.0.2,<2.0.0",
+    "layouta>=1.1.0,<2.0.0",
+    "mundare>=1.0.2,<2.0.0",
+    "pagenumber>=1.0.0,<2.0.0",
+    "pdflog>=1.0.2,<2.0.0",
+    "qvlink>=2.15.7,<3.0.0",
+    "rawmaker>=2.40.5,<3.0.0",
+    "reftable>=1.0.0,<2.0.0",
+    "responsio>=1.15.6,<2.0.0",
+    "tablero>=1.0.1,<2.0.0",
+    "titulum>=1.0.2,<2.0.0",
+    "ughost>=1.1.1,<2.0.0",
+    "utilo>=2.112.1,<3.0.0",
+    "verbo>=1.23.4,<2.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 = [
+    "gennex==1.1.0",
+    "hoverpower==1.7.0",
+    "utilotest==1.1.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/anaticulae/queuemo"
+Repository = "https://github.com/anaticulae/queuemo"
+
+[project.scripts]
+queuemo = "queuemo.cli.main:main"
+queuemo_single = "queuemo.cli.single:main"
+queuemo_state = "queuemo.cli.state:main"
+
+[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 = [
+    "queuemo",
+    "queuemo.cli",
+    "queuemo.recipes",
+    "queuemo.recipes.fastview",
+    "queuemo.recipes.publish",
+    "queuemo.recipes.result",
+    "queuemo.recipes.validation",
+    "queuemo.runtime",
+    "queuemo.worker",
+]
+exclude = [
+    "tests*",
+]
+
+[tool.hoverpower]
+packages = [
+    "BACHELOR",
+    "HOME",
+    "MASTER",
+    "ORDER",
+    "PAPER",
+]

queuemo-1.27.6/queuemo/__init__.py

@@ -0,0 +1,24 @@
+#==============================================================================
+# 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 importlib.metadata
+import os
+
+import queuemo.__patch__
+from queuemo.runtime.api import RecipeIO
+from queuemo.runtime.scheduler import isrequired
+from queuemo.runtime.scheduler import required
+
+__version__ = importlib.metadata.version('queuemo')
+
+ROOT = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+
+PROCESS = 'queuemo'
+
+INTERACTIVE = False  # if True, pause on every scheduler step

queuemo-1.27.6/queuemo/__main__.py

@@ -0,0 +1,14 @@
+# =============================================================================
+# 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.
+# =============================================================================
+"""Evaluate cmd-args and execute commands"""
+
+import queuemo.cli.main
+
+if __name__ == "__main__":
+    queuemo.cli.main.main()

queuemo-1.27.6/queuemo/__patch__.py

@@ -0,0 +1,8 @@
+# =============================================================================
+# 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.
+# =============================================================================

queuemo-1.27.6/queuemo/cli/__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.
+# =============================================================================

queuemo-1.27.6/queuemo/cli/main.py

@@ -0,0 +1,185 @@
+# =============================================================================
+# 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 collections
+
+import configos
+import qvlink
+import serializeraw
+import utilo
+import utilo.cli
+
+import queuemo
+import queuemo.cli.utils
+import queuemo.runnable
+
+RUNTIME = 'runtime'
+WAITING = 'waiting'
+JOBS = 'jobs'
+VERBOSE = 'verbose'
+INTERACTIVE = 'interactive'
+
+Config = collections.namedtuple(
+    'Config',
+    ('interactive failfast showdebug clean runtime waiting '
+     'jobs verbose http skip_unsupported webconfig'),
+)
+
+
+@utilo.saveme
+def main():
+    config = evaluate_cli()
+    if config == utilo.INVALID_COMMAND:
+        return utilo.INVALID_COMMAND
+    # run showdebug
+    if config.showdebug:
+        return showdebug()
+    configure(config)
+    closed = worker_startup(config)
+    return closed
+
+
+def configure(config: Config):
+    queuemo.INTERACTIVE = config.interactive
+    queuemo.cli.utils.logger_start()
+    if config.interactive:
+        utilo.log('use interactive mode')
+    if not utilo.testing():
+        # ensure that all test directories are created
+        configos.makedirs()
+    # check startup
+    configos.check_startup()
+    if config.clean:
+        # remove outdated maybe failed jobs
+        qvlink.remove_outdated()
+    # run http interface if required
+    if config.http:
+        http_startup()
+
+
+def worker_startup(config: Config):
+    # start scheduler
+    import queuemo.worker.startup  # pylint:disable=W0621,C0415
+    closed = queuemo.worker.startup.run(
+        failfast=config.failfast,
+        jobs=config.jobs,
+        runtime=config.runtime,
+        skip_unsupported=config.skip_unsupported,
+        verbose=config.verbose,
+        waiting=config.waiting,
+        webconfig=config.webconfig,
+    )
+    return closed
+
+
+def http_startup():
+    # lower queuemo start time, flask requires a second of init time
+    import queuemo.runtime.control  # pylint:disable=W0621,C0415
+    queuemo.runtime.control.start()
+
+
+CMDS = [
+    utilo.Parameter(
+        longcut=RUNTIME,
+        message='runtime in ticks',
+        args={
+            'default': 100,
+        },
+    ),
+    utilo.Parameter(
+        longcut=WAITING,
+        message='time to wait for the next job in miliseconds',
+        args={
+            'default': 1000,
+        },
+    ),
+    utilo.Parameter(
+        longcut=JOBS,
+        message='maximal number of executed jobs',
+        args={
+            'default': 1000,
+        },
+    ),
+    utilo.Flag(
+        longcut=INTERACTIVE,
+        message='pause on every recipe step and ask to continue',
+    ),
+    utilo.Flag(
+        longcut='failfast',
+        message='fail on first error',
+    ),
+    utilo.Flag(
+        longcut='http',
+        message='start http interface',
+    ),
+    utilo.Flag(
+        longcut='showdebug',
+        message='show list of installed runnable and return',
+    ),
+    utilo.Flag(
+        longcut='clean',
+        message='clean outdated jobs',
+    ),
+    utilo.Flag(
+        longcut='skip_unsupported',
+        message='do not analyze not supported documents',
+    ),
+    utilo.Parameter(
+        longcut='webconfig',
+        message='select msgids of published findings',
+    ),
+]
+
+
+def evaluate_cli() -> Config:
+    parser = utilo.cli.create_parser(
+        todo=CMDS,
+        config=utilo.ParserConfiguration(
+            waitingflag=False,
+            cacheflag=False,
+            pages=False,
+        ),
+        prog=queuemo.PROCESS,
+        version=queuemo.__version__,
+    )
+    args = utilo.parse(parser)
+    try:
+        webconfig = args.get('webconfig', None)
+        if webconfig:
+            if not utilo.exists(webconfig):
+                utilo.error(f'webconfig does not exists: {webconfig}')
+                return utilo.INVALID_COMMAND
+            utilo.debug(f'use webconfig: {webconfig}')
+            webconfig = serializeraw.load_webconfig(webconfig)
+        config = Config(
+            args[INTERACTIVE],
+            args.get('failfast', False),
+            args.get('showdebug', False),
+            args.get('clean', False),
+            int(args[RUNTIME]),
+            int(args[WAITING]),
+            int(args[JOBS]),
+            int(args[VERBOSE]) if args[VERBOSE] else 0,
+            args.get('http', False),
+            args.get('skip_unsupported', False),
+            webconfig=webconfig,
+        )
+    except ValueError:
+        msg = (f'invalid start parameter: `{args[RUNTIME]}`, `{args[WAITING]}`,'
+               f' `{args[VERBOSE]}`, `{args[JOBS]}`')
+        utilo.error(args)
+        utilo.error(msg)
+        return utilo.INVALID_COMMAND
+    utilo.level_setup(config.verbose)
+    return config
+
+
+def showdebug():
+    queuemo.runnable.check()
+    return utilo.SUCCESS

queuemo-1.27.6/queuemo/cli/single.py

@@ -0,0 +1,107 @@
+# =============================================================================
+# 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.
+# =============================================================================
+"""Run queuemo for selected pdf file."""
+
+import os
+
+import configos
+import qvlink
+import utilo
+import utilo.cli
+import utilo.logger
+
+import queuemo
+import queuemo.cli.utils
+import queuemo.runtime.api
+import queuemo.runtime.execute
+import queuemo.worker.startup
+
+COMMANDS = [
+    utilo.Flag(longcut='create'),
+]
+DESCRIPTION = """\
+Run queuemo recipe for given -i input and write to -o folder.
+"""
+
+
+@utilo.saveme
+def main() -> int:
+    inpath, outpath, verbose, create = eval_cli()
+    utilo.logger.level_setup(utilo.Level(verbose))
+    queuemo.cli.utils.logger_start()
+    if os.path.isfile(inpath):
+        if create:
+            inpath = create_todo(inpath, outpath)
+            if inpath == utilo.FAILURE:
+                return utilo.FAILURE
+        else:
+            utilo.error(f'require directory: {inpath} or use --create flag')
+            return utilo.INVALID_COMMAND
+    outpath = inpath
+    utilo.log(f'write result to: {outpath}')
+    # patch todo outpath path. TODO: INVESTIGATE HERE?
+    todopath = os.path.normpath(os.path.join(inpath, os.path.pardir))
+    configos.todo = lambda _=False: todopath
+    configos.ready = lambda _=False: todopath
+    # analyze single document
+    tmpdir = utilo.tmpdir(configos.tmp())
+    jobid = queuemo.worker.startup.jobid(inpath)
+    queuemo.runtime.execute.run_document(
+        workspace=tmpdir,
+        documentid=jobid,
+        outpath=outpath,
+        config=queuemo.runtime.api.RecipeConfig(verbose=verbose),
+    )
+    return utilo.SUCCESS
+
+
+def eval_cli() -> tuple:
+    parser = utilo.cli.create_parser(
+        description=DESCRIPTION,
+        todo=COMMANDS,
+        config=utilo.ParserConfiguration(
+            inputparameter=True,
+            outputparameter=True,
+        ),
+        prog='queuemo_single',
+        version=queuemo.__version__,
+    )
+    args = utilo.parse(parser)
+    inpath, outpath, verbose = utilo.sources(  # pylint:disable=W0632
+        args,
+        singleinput=True,
+        use_cwd=False,
+        verbose=True,
+    )
+    inpath = inpath[0]
+    create = args.get('create', False)
+    return inpath, outpath, verbose, create
+
+
+def create_todo(inpath, outpath):
+    filename = str(os.path.split(inpath)[1])
+    if outpath:
+        outpath, outname = os.path.split(outpath)
+    else:
+        outpath = os.getcwd()
+        # remove file name
+        outname = filename.replace('.pdf', '')
+    try:
+        outpath = qvlink.create_todo(
+            file=inpath,
+            filename=filename,
+            todoname=outname,
+            todopath=outpath,
+            exist_ok=True,
+        )
+    except OSError:
+        utilo.error(f'{os.path.join(outpath, outname)} already exists')
+        return utilo.FAILURE
+    utilo.log(f'create job description in {outpath}')
+    return outpath

queuemo-1.27.6/queuemo/cli/state.py

@@ -0,0 +1,104 @@
+# =============================================================================
+# 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 argparse
+import sys
+
+import configos
+import qvlink
+import utilo
+
+
+@utilo.saveme
+def main() -> int:
+    action = eval_cli()
+    if action.kill:
+        kill(action.kill)
+        return utilo.SUCCESS
+    utilo.log('verify state ...')
+    utilo.log(f'    todo: {configos.todo()}')
+    print_running()
+    print_waiting()
+    return utilo.SUCCESS
+
+
+def print_running():
+    print_documents(qvlink.State.RUNNING)
+
+
+def print_waiting():
+    print_documents(qvlink.State.WAITING)
+
+
+def print_documents(state):
+    # TODO: PASS READY AND TODO TO AVOID REQUIRED COMMON PARENT
+    common = utilo.path_parent(configos.ready())
+    documents = qvlink.load_documents(
+        common=common,
+        owner=None,
+        state=state,
+    )
+    if not documents:
+        utilo.log(f'no {state.name} documents')
+        return
+    utilo.log(f'\n{state.name} documents({len(documents)}):')
+    for document in documents:
+        print_document(document)
+
+
+def print_document(document):
+    pages = str(document.get('pages')).zfill(3)
+    title = document.get('title')
+    date = document.get('date')
+    name = document.get('name')
+    utilo.log(f'   - {name} {date} {pages} {title}')
+
+
+def kill(documentid: str):
+    if documentid == 'all':
+        todos = collect_all()
+        if not todos:
+            utilo.error('nothing to kill')
+            sys.exit(utilo.INVALID_COMMAND)
+        for jobinfo in todos:
+            kill(jobinfo.name)
+        return
+    if not qvlink.document(documentid=documentid):
+        utilo.exitx(f'invalid documentid: {documentid}', utilo.INVALID_COMMAND)
+    if qvlink.deleted(documentid):
+        utilo.exitx(f'already deleted: {documentid}', utilo.INVALID_COMMAND)
+        return
+    if qvlink.delete(documentid):
+        utilo.log(f'killed: {documentid}')
+        return
+    utilo.error(f'could not kill: {documentid}')
+    sys.exit(utilo.INVALID_COMMAND)
+
+
+def collect_all() -> list:
+    todos = qvlink.collect_jobs()[0]
+    result = []
+    for todo in todos:
+        process = qvlink.current(todo.documentid)
+        current: qvlink.State = qvlink.State.fromstate(process)
+        if current not in (qvlink.State.WAITING, qvlink.State.RUNNING):
+            continue
+        result.append(todo)
+    return result
+
+
+def eval_cli():
+    parser = argparse.ArgumentParser(prog='queuemo_state',)
+    parser.add_argument(
+        '--kill',
+        nargs='?',
+        help='stop single job, use all to stop all pending jobs',
+    )
+    result = parser.parse_args()
+    return result