aas-readable 0.1.0__tar.gz

aas_readable-0.1.0/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.

aas_readable-0.1.0/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: aas-readable
+Version: 0.1.0
+Summary: Export Asset Administration Shell environments to human-readable Markdown
+Author: Ethan Rozee
+License: Apache-2.0
+Keywords: aas,aasx,digital-twin,industry-4-0,markdown,llm
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Documentation
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: aasx
+Requires-Dist: basyx-python-sdk>=1.2; extra == "aasx"
+Dynamic: license-file
+
+# AAS-Readable
+
+`AAS-Readable` converts Asset Administration Shell content into clean Markdown for engineers, analysts, and LLM workflows.
+
+It is meant for the gap between machine-readable digital twins and human-readable insight.
+
+## What It Does
+
+The exporter reads:
+
+- `.aasx` packages
+- plain AAS JSON environments
+- wrapped JSON records where the AAS is stored under `aas`
+
+It writes:
+
+- one Markdown file per submodel
+- `index.md` as a navigation page
+- `llm-context.md` as a compact prompt-ready summary
+
+## Why Markdown
+
+AAS content is structured and interoperable, but it is not always easy to inspect directly during engineering work.
+
+Markdown makes a digital twin easier to:
+
+- review in Git
+- publish as internal documentation
+- index with standard search tools
+- compare between revisions
+- paste into an LLM without extra cleanup
+
+In practice, this means you can turn an operational twin into something that explains what is currently happening, what changed recently, and which submodels matter.
+
+## Why This Is Useful For LLMs
+
+LLMs work better when the input is compact, hierarchical, and explicit about context.
+
+`llm-context.md` is designed around that constraint. It keeps the most useful information in one predictable document:
+
+- asset identity
+- referenced submodels
+- canonical narrative text when present
+- condensed summaries of submodel elements
+
+That makes it useful for tasks such as:
+
+- status summarization
+- maintenance brief generation
+- comparing twin snapshots
+- spotting missing fields
+- building retrieval corpora from AAS exports
+
+## Installation
+
+`pip install -e .` is only for a local clone of the repository. It is useful for development, but it is not the normal install command for users downloading the tool from GitHub.
+
+### Install From GitHub
+
+JSON-only usage:
+
+```bash
+pip install "git+https://github.com/erozee1/AAS-Readable.git"
+```
+
+With `.aasx` support:
+
+```bash
+pip install "git+https://github.com/erozee1/AAS-Readable.git#egg=aas-readable[aasx]"
+```
+
+### Install From A Local Clone
+
+Clone the repository first:
+
+```bash
+git clone https://github.com/erozee1/AAS-Readable.git
+cd AAS-Readable
+```
+
+Standard local install:
+
+```bash
+pip install .
+```
+
+Editable local install for development:
+
+```bash
+pip install -e .
+```
+
+### Optional `.aasx` Support
+
+If you are installing from a local clone and want `.aasx` support:
+
+```bash
+pip install -e '.[aasx]'
+```
+
+The optional `aasx` extra installs the Eclipse BaSyx Python SDK.
+
+### Recommended Virtual Environment Setup
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+```
+
+Then run one of the install commands above.
+
+## CLI
+
+```bash
+aas-readable INPUT_PATH OUTPUT_DIR [--include SUBMODEL_NAME] [--overwrite]
+```
+
+### Examples
+
+Export a JSON environment:
+
+```bash
+aas-readable app_aas.json out/
+```
+
+Export a packaged twin:
+
+```bash
+aas-readable machine.aasx out/
+```
+
+Export selected submodels only:
+
+```bash
+aas-readable machine.aasx out/ \
+  --include "Technical Data" \
+  --include "Operational Data"
+```
+
+Reuse an existing output directory:
+
+```bash
+aas-readable machine.aasx out/ --overwrite
+```
+
+After installation, verify that the CLI is available:
+
+```bash
+aas-readable --help
+```
+
+## Input Shapes
+
+### Plain AAS JSON
+
+The exporter supports environments that directly contain:
+
+- `assetAdministrationShells`
+- `submodels`
+
+### Wrapped Records
+
+It also supports records like this:
+
+```json
+{
+  "canonical_text": "...",
+  "aas": {
+    "assetAdministrationShells": [],
+    "submodels": []
+  }
+}
+```
+
+If `canonical_text` is present, it is included in `llm-context.md`.
+
+## Output Layout
+
+```text
+out/
+  index.md
+  llm-context.md
+  staticdata.md
+  functionaldata.md
+  operationaldata.md
+  lifecycledata.md
+```
+
+Filenames are derived from submodel names and normalized to stable lowercase slugs.
+
+## Example Export
+
+The repository includes a generated example in [examples/meng-app-aas](examples/meng-app-aas).
+
+That folder contains:
+
+- [index.md](examples/meng-app-aas/index.md)
+- [llm-context.md](examples/meng-app-aas/llm-context.md)
+- one Markdown file per submodel
+
+The example was generated from a related AAS dataset containing plain JSON environments and wrapped JSON records with `canonical_text`.
+
+## How It Works
+
+The exporter follows a deliberately small pipeline:
+
+1. Load the input source.
+2. Normalize it into an internal document model.
+3. Render deterministic Markdown.
+
+This keeps parsing concerns separate from rendering concerns, which is important for stable diffs and stable LLM context.
+
+## Current Scope
+
+Included:
+
+- AAS JSON export
+- wrapped JSON export with `canonical_text`
+- optional `.aasx` export via BaSyx
+- recursive rendering of nested submodel elements
+- `index.md`
+- `llm-context.md`
+
+Not included yet:
+
+- specialized renderers for specific IDTA templates
+- supplementary file extraction from `.aasx`
+- round-trip editing back into AAS
+- UI or hosting components
+
+## Development
+
+Run the tests:
+
+```bash
+PYTHONPATH=src python3 -m unittest discover -s tests -v
+```
+
+Show CLI help:
+
+```bash
+PYTHONPATH=src python3 -m aas_readable.cli --help
+```
+
+## License
+
+This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE).
+
+## Further Reading
+
+- [docs/research.md](docs/research.md)
+- [docs/cli-plan.md](docs/cli-plan.md)