stage-foundary 0.1.4__tar.gz

stage_foundary-0.1.4/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 2026 Reiner Jung
+
+   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.

stage_foundary-0.1.4/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: stage_foundary
+Version: 0.1.4
+Summary: Foundary of standard stages
+Home-page: https://gitlab.opencode.de/oc00006954184/stage-foundary
+Author: Reiner Jung
+Author-email: reiner.jung@stk.landsh.de
+License: EU_PL
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.6
+License-File: LICENSE
+
+UNKNOWN
+

stage_foundary-0.1.4/README.md

@@ -0,0 +1,165 @@
+# Stage Foundary
+
+Processing data with a pipe and filter (stages) framework is a common approach. This stage foundary contains a collection
+of commonly used stages to read CSVs, XLSXs, Jira-tickets and other sources and search filter and combine data
+to create reports. They follow the basic layout of stages from the TeeTime Java and C++ framework. This has been
+chosen to be able to later port it to the Python implementation of TeeTime.
+
+The following contains general information on the stage foundary.
+
+## Key concepts
+
+### ProducerStage
+
+Each pipeline must contain at least one `ProducerStage`
+
+```
+class MyProducerStage(ProducerStage):
+
+    def __init__(self, logger: logging.Logger):
+        super().__init__(logger)
+
+    def execute(self):
+        self.output_port.send(EVENT TO BE SENT)
+        # to mark the end of processing
+        self.work_complete()
+```
+
+### ConsumerStage
+
+In pipeline single stages have only one input and one output port. To ease the implementation,
+the `ConsumerStage` supports this processing style
+
+```
+class MyConsumerStage(ConsumerStage):
+
+    def __init__(self, logger: logging.Logger):
+        super().__init__(logger)
+
+    # element is the incoming event
+    def consume(self, element: any) -> None:
+        self.output_port.send(EVENT TO BE SENT)        
+```
+
+### SinkStage
+
+The end of a pipeline conains a `SinkStage`. They do not posses an output port.
+
+```
+class MySinkStage(SinkStage):
+
+    def __init__(self, logger: logging.Logger):
+        super().__init__(logger)
+
+    # element is the incoming event
+    def consume(self, element: any) -> None:
+```
+
+### Basic program
+
+```
+import argparse as arg
+import logging
+import datetime
+
+import stage_foundary.teetime
+
+#
+# Setup logger
+#
+logger = logging.getLogger(__file__)
+logging.basicConfig(level=logging.INFO)
+
+# often one needs the current date
+date = datetime.datetime.now()
+
+#
+# parameter
+#
+
+parser = arg.ArgumentParser(NAME OF THE TOOL)
+
+parser.add_argument("-i", dest="input_path", required=True)
+
+# check parameters here
+
+#
+# create stages
+#
+class Configuration(teetime.Configuration):
+
+    def create_configuration(self):
+        producer = MyProducerStage(logger)
+        consumer = MyConsumerStage(logger)
+        sink = MySinkStage(logger)
+
+        # connect stages
+        self.connect(producer, consumer)
+        self.connect(consumer, sink)
+
+
+execution = Execution()
+execution.run(FuPoStatsConfiguration())
+
+```
+
+Stages must be connected to each other. Stages with only one input and one output port
+can be connected by handing the stages to the `connect` method. Other stages, e.g.,
+the `split` stage has multiple output ports, here you must give the correct output port
+as parameter to the connect method, e.g., `split.get_port(0)`.
+
+## CI and CD
+
+- Development is conducted in the `main` branch or, for larger new features, in a
+  dedicated feature branch.
+- The release train should be conducted as follows:
+  - make sure all features are merged into the main branch
+  - determine new version number
+  - create a release branch
+  - add infos to the changelog on changes
+  - update version number in project.toml and setup.py
+  - push branch
+  - the CI will:
+    - build and test the package
+    - run integration tests
+    - deploy to testpypi
+    - sign
+    - deploy to pypi
+  - Merge release branch back to main
+
+## Integrate with your tools
+
+* [Set up project integrations](https://gitlab.opencode.de/oc00006954184/stage-foundary/-/settings/integrations)
+
+## Collaborate with your team
+
+* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
+* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
+* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
+* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
+* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+
+## Test and Deploy
+
+Use the built-in continuous integration in GitLab.
+
+* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
+* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
+* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
+* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
+* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
+
+***
+
+## Authors and acknowledgment
+
+Reiner Jung
+
+## License
+
+The code is licensed under the EUPL-1.2
+
+## Project status
+
+We will add to this every time a stage is used in multiple analyses to gradually build reusable parts and
+reduce the effort necessary to create analyses in project managing and rollout coordination-

stage_foundary-0.1.4/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "stage_foundary"
+version = "0.1.4"
+authors = [
+  { name="Reiner Jung", email="reiner.jung@stk.landsh.de" },
+]
+description = "Foundary of standard stages"
+readme = "README.md"
+requires-python = ">=3.6"
+classifiers = [
+    'Development Status :: 3 - Alpha',
+    'Intended Audience :: Science/Research',
+    'Operating System :: POSIX :: Linux',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.6',
+]
+license = "EUPL-1.2"
+license-files = ["LICENSE*"]
+
+dependencies = [
+    'jira',
+]
+
+[project.urls]
+Homepage = "https://gitlab.opencode.de/oc00006954184/stage-foundary"
+Issues = "https://gitlab.opencode.de/oc00006954184/stage-foundary"

stage_foundary-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

stage_foundary-0.1.4/setup.py

@@ -0,0 +1,23 @@
+from setuptools import setup
+
+setup(
+    name="stage_foundary",
+    version="0.1.4",
+    description="Foundary of standard stages",
+    url="https://gitlab.opencode.de/oc00006954184/stage-foundary",
+    author="Reiner Jung",
+    author_email="reiner.jung@stk.landsh.de",
+    license="EU_PL",
+    packages=["stage_foundary"],
+    install_requires=[
+        "jira",
+    ],
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)",
+        "Operating System :: POSIX :: Linux",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+    ],
+)

stage_foundary-0.1.4/stage_foundary/__init__.py

@@ -0,0 +1,9 @@
+"""
+stage_foundary
+
+Collection of common stages used to create all kind of data analyis
+"""
+
+__version__ = "0.1.0"
+__author__ = "Reiner Jung"
+__credits__ = "Zentrale IT des Landes Schleswig-Holstein"