semantic-api 0.0.1__tar.gz

semantic_api-0.0.1/.gitignore

@@ -0,0 +1,175 @@
+# from https://github.com/github/gitignore/blob/main/Python.gitignore#L1C1-L174C8
+# Byte-compiled / optimized / DLL files
+*/__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc

semantic_api-0.0.1/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 [yyyy] [name of copyright owner]
+
+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.

semantic_api-0.0.1/NOTICE

@@ -0,0 +1 @@
+Copyright 2025 William A Coolidge and the SDU (University of Southern Denmark) contributors 

semantic_api-0.0.1/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: semantic-api
+Version: 0.0.1
+Summary: A simple python API for creating, inserting, querying, and processing semantic data. This requires semantic services that are not included here
+Project-URL: Homepage, https://source.coderefinery.org/wac/semantic-api
+Project-URL: Issues, https://source.coderefinery.org/wac/semantic-api/-/issues
+Author-email: William A Coolidge <wac@mmmi.sdu.dk>
+License: Apache Licenses 2.0
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Requires-Dist: behave==1.2.6
+Requires-Dist: future==0.18.2
+Requires-Dist: paho-mqtt==2.1.0
+Requires-Dist: pydantic-core==2.27.2
+Requires-Dist: pydantic==2.10.4
+Requires-Dist: pymonad==2.4.0
+Requires-Dist: pyrsistent==0.20.0
+Requires-Dist: typing-extensions==4.12.2
+Requires-Dist: typing==3.7.4.3
+Requires-Dist: urllib3==1.26.5
+Description-Content-Type: text/markdown
+
+
+# Semantic API
+
+#### Versions
+
+```0.0.1``` : Intial version with only the API for insertion and query.
+
+| Element | Status | Comment |
+|:--- |:--- |:--- |
+| insert  | ✅ | complete |
+| query  | ✅ | complete |
+| typelib |   ❌  | in-process |
+| type tools | ❌ | in-process |
+| database tools | ❌ | in-process |
+| chain tools  | ❌ | in-process | 
+
+
+#### 1 [Python API](src/doc/python-api.md#python-api-concept)
+
+#### 2 [Background](src/doc/background.md)
+
+#### 3 [RDF and Types](src/doc/rdf-and-types.md)
+
+#### 4 [Editing Ontologies](src/doc/editing-ontologies.md)
+
+
+
+

semantic_api-0.0.1/README.md

@@ -0,0 +1,28 @@
+
+# Semantic API
+
+#### Versions
+
+```0.0.1``` : Intial version with only the API for insertion and query.
+
+| Element | Status | Comment |
+|:--- |:--- |:--- |
+| insert  | ✅ | complete |
+| query  | ✅ | complete |
+| typelib |   ❌  | in-process |
+| type tools | ❌ | in-process |
+| database tools | ❌ | in-process |
+| chain tools  | ❌ | in-process | 
+
+
+#### 1 [Python API](src/doc/python-api.md#python-api-concept)
+
+#### 2 [Background](src/doc/background.md)
+
+#### 3 [RDF and Types](src/doc/rdf-and-types.md)
+
+#### 4 [Editing Ontologies](src/doc/editing-ontologies.md)
+
+
+
+

semantic_api-0.0.1/pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "semantic-api"
+version = "0.0.1"
+dependencies = [
+    "behave == 1.2.6",
+    "paho-mqtt == 2.1.0",
+    "pydantic == 2.10.4",
+    "pydantic_core == 2.27.2",
+    "PyMonad == 2.4.0",
+    "pyrsistent == 0.20.0",
+    "future == 0.18.2",
+    "typing == 3.7.4.3",
+    "typing_extensions == 4.12.2",
+    "urllib3 == 1.26.5"
+]
+authors = [
+  { name="William A Coolidge", email="wac@mmmi.sdu.dk" },
+]
+description = "A simple python API for creating, inserting, querying, and processing semantic data. This requires semantic services that are not included here"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = {text="Apache Licenses 2.0"}
+license-files = ["LICEN[CS]E*"]
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/semantic-api"]
+
+[project.urls]
+Homepage = "https://source.coderefinery.org/wac/semantic-api"
+Issues = "https://source.coderefinery.org/wac/semantic-api/-/issues"
+
+
+    

semantic_api-0.0.1/src/doc/background.md

@@ -0,0 +1,70 @@
+
+## 1 Background
+
+The semantic-api assumes that the user is concerned with the ontological modeling and subequent programatic use in systems rather than the semantic-web representation of the system. The difference is subtle, but significant, as the concerns of system wide exploitation of a taxonomy used to define the system are different than that of an interface to a semantic-web application. 
+
+The system-wide defintion of types is assumed to be a requirement in the following, with the exposure to the semantic-web as secondary to client and system services usage.
+
+In the ideal case, all aspects of the sytem are staticlly typed such that the ontology serves as a system wide definition that the compiler checks at build time on every signature and return type.
+
+In the worst case, the data types are only validated on insertion to the database for programming languages with little or no type support.
+
+The central postulate of the author is that modeling is a infinite task that implies continuous change to type definitions throughout the system. The approach taken here, is not to resist type change through standardization, or containment to an API or external interfaces,  but to assume and embrace type change through the system programming. 
+
+The central postulate is that an ontolgogicaly defined system requires an environment that supports type change and that this is best achieved with system libraries that are compliled for the ontologies at hand. Statically typed languages are the obvious choice under these requirements but this type centric approach should be maintained for non-statically-typed languages such as Python.
+
+In all cases, the type definitions for the ontology should be local such that code generation is available to the programmer. This can be realized via the native type definitions of statically type languages, definition language for schemas or ontolgies, a DSL for types, or a combination of paths.  Regardless of the means, some form of definition becomes the internal representation that results in compiled type definitions to allow for type validation, code generation, and reasoning. This can be thought of as a ***typed-client*** analogous to a ***thick-client*** where services (in this case types) are available directly on the client.
+
+Versioning shall be applied such that type evolution can be discerned at the type, cluster, and schema levels.
+
+The following documents the current state of this development from the user's point of view.
+
+
+### 1.1 Context
+
+The context for this effort is formed by a set of observations or ***postulates***:
+
+ - ***types are the symbolic representations of the system (vocabulary, taxonomy, langauge model)***
+ - ***the inter-dependence of system types forms a graph of types which we call an ontology***
+ - ***system design and inteface design starts with types***
+ - ***these types define the semantics of the system, i.e. form a model of the system***
+ - ***specific instances of types are what we call semantic data***
+ - ***a function is defined by the mapping between the type of its argument and its return type***
+ - ***modeling of the world (system) is an infinite task since our concerns and the world are both continuously changing***
+ - ***we need to be able to easily handle the evolution and change of our world models (ontologies)***
+ - ***system wide types have a positive effect on the development and the subsequent quality of the system***
+ - ***we need to be able to handle the evolution and change of our program types***
+ - ***the complexity of programing with semantic data, i.e. defining, creating, querying, formatting, and processing of semantic data is limiting exploitation***
+ - ***programming with semantic data (on graphs of type instances) is poorly developed in light of its potential***
+ 
+
+### 1.2 Goals
+
+The goal is to enable semantic techologies to be exploited in projects. This envolves simplifying:
+
+ - the definition, selection, and layering of ontologies
+ - the creation of semantic data
+ - the querying, formatting, and processing of semantic data
+ 
+
+Furthermore, It is an implied requirement is that any semantic middleware, or configuration detail, is kept out of the user's functional, in-band, or business logic.
+ 
+
+### 1.3 Use and Exploitation Potential
+
+System wide ontologies and local programming with types are expeced to be exploited in:
+ - code quality: ensuring instance data is correct at run-time (as well as development and compile time correctness)
+ - metadata: model higher level environmental contexts, use-cases, configuration, scenarios, tasks, agents, actors, not just entities, behaviour, and actions
+ - state machines: state machine states and events as types
+ - observability: full semantic coverage of system and sub-system states and errors
+ - availability: provide clients with the list of the current actions/operations that a user can make for the current service/error state (HATEOAS)
+ - controllability: model the full plant and control space with parameter, error, and noise effects
+ - modeling: address the extra dimensions of concern that are not modeled
+ - temporality: model the temporal dimension so that all captured semantic data is unique and represents an event
+ - policies: exploit events by using ontologically defined conditions on policy agents
+ - reasoning: exploit reasoning on types and type properties to create knowledge bases
+ - empirical models: use bottom up techniques, both classical and machine learning techniques to validate if not inform symbolic types
+
+[NEXT](rdf-and-types.md)
+
+[HOME](../../README.md)