opensysml 0.3.0__tar.gz

opensysml-0.3.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 Open-MBEE
+
+   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.

opensysml-0.3.0/PKG-INFO

@@ -0,0 +1,240 @@
+Metadata-Version: 2.4
+Name: opensysml
+Version: 0.3.0
+Summary: Python client library for OpenSysML, a SysML v2 parser and execution runtime
+Author: Open-MBEE
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Open-MBEE/OpenSysML
+Project-URL: Repository, https://github.com/Open-MBEE/OpenSysML
+Project-URL: Documentation, https://github.com/Open-MBEE/OpenSysML/blob/main/python/README.md
+Project-URL: Changelog, https://github.com/Open-MBEE/OpenSysML/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/Open-MBEE/OpenSysML/issues
+Keywords: sysml,sysmlv2,kerml,mbse,systems-engineering
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Compilers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: grpcio>=1.83.0
+Requires-Dist: protobuf>=7.35.1
+Requires-Dist: filelock>=3.0.0
+Requires-Dist: psutil>=5.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-mock>=3.10.0; extra == "dev"
+Requires-Dist: grpcio-tools>=1.83.0; extra == "dev"
+Requires-Dist: mypy>=1.8.0; extra == "dev"
+Requires-Dist: types-protobuf>=4.24.0; extra == "dev"
+Requires-Dist: types-psutil>=5.9.0; extra == "dev"
+Requires-Dist: grpc-stubs>=1.53.0; extra == "dev"
+Requires-Dist: pandas-stubs>=2.0.0; extra == "dev"
+Requires-Dist: numpy<2.5; extra == "dev"
+Dynamic: license-file
+
+# opensysml
+
+Python client for OpenSysML: parse, inspect and execute SysML v2 models over the
+`sysml-grpc` service.
+
+```bash
+pip install opensysml             # from PyPI, once the first release is published
+pip install -e python/          # or from a checkout, at the repository root
+```
+
+```python
+import opensysml
+
+model = opensysml.load("model.sysml", strict=True)   # raises on error diagnostics
+print(model.eval("1 + 2 * 3"))                     # 7
+
+print(model.eval("mass", subject="Demo::sedan"))   # 1200.0 — that object, not the default
+                                                   # requires the service's evaluate_subject
+                                                   # capability, rather than trusting a
+                                                   # service that would ignore the subject
+
+vehicle = model["Vehicle"]                         # by short name or FQN
+vehicle.attributes()                               # own and inherited, with resolved facts
+inst = model.instantiate("Demo::Vehicle")
+inst.mass                                          # 1500.0 [kg] — a Quantity
+
+model.verify_satisfaction()                        # every assert satisfy … by …
+model.save("model.ttl")                            # RDF Turtle (experimental)
+```
+
+Declarations can be authored from notation strings while preserving the
+untouched source:
+
+```python
+model.edit().add_part_def("", "Vehicle").apply()
+model.edit().add_part("Vehicle", "engine", type="Engine").apply()
+```
+
+Use `opensysml.loads(text, language="kerml")` for inline KerML content.
+
+Every call goes through the `sysml-grpc` service, which `opensysml` starts for you from
+`~/.opensysml/bin/sysml-grpc`; the guide below says how to put it there.
+
+## Service ownership
+
+`opensysml` never stops a service it did not start.
+
+- A connection that finds a healthy service already listening uses it and takes
+  no ownership of it: nothing is recorded, and closing the connection leaves the
+  service running. Whoever started it decides when it stops.
+- A service `opensysml` starts is recorded in
+  `~/.opensysml/sysml-grpc-<port>.pid` (`$OPENSYSML_STATE_DIR` overrides the
+  directory) as the service's pid and process start time, plus the pid and start
+  time of the process that started it. Only that process stops it, and only when
+  the last connection holding it is closed or the interpreter exits.
+- The start times are what authenticate the record: a pid is re-checked against
+  the start time written for it, so a pid the operating system has since reused
+  is treated as a stale record — cleaned up, never signalled. A command line
+  that merely looks like `sysml-grpc` is not identity and is never acted on.
+- A service that crashes leaves a record whose process is gone; the next
+  connection detects that, removes it and starts a service of its own.
+
+## Pinned release digests
+
+A download is verified against `PINNED_SHA256` in `opensysml/binary.py`, which
+pins the SHA-256 of every asset of a release. The `.sha256` served beside a
+binary comes from whoever served the binary, so it detects corruption but not a
+republished release; a pinned digest is independent of that origin. A download
+with no pin fails with a message naming the version, rather than falling back to
+the served checksum — `$OPENSYSML_ALLOW_UNPINNED_DOWNLOAD=<owner/repo>` (or `=1` for
+any repository) accepts same-origin trust explicitly for what it names, with a
+warning.
+
+At release time, after the service binaries are published and final:
+
+```bash
+export GITHUB_TOKEN=...            # the release API rate-limits unauthenticated calls
+python scripts/pin_release_checksums.py --version v0.0.9 --write
+git commit -am 'chore(python): pin release digests for v0.0.9'
+```
+
+The script downloads every `sysml-grpc-*` asset of that release, hashes what it
+downloaded, refuses the release if a `.sha256` sidecar disagrees with the asset
+it describes, and rewrites the table in place. `--check` re-hashes the assets of
+every pinned release and fails on any disagreement, catching a release
+republished with another binary. A opensysml release therefore pins the service
+releases published before it; asking for a newer one needs a newer opensysml (or
+the explicit opt-in above), and leaves an already-downloaded binary serving
+rather than refusing to start — only a digest that *contradicts* a pin is
+treated as tampering and refuses to fall back.
+
+## Version
+
+`opensysml/_version.py` is the only declaration: the packaging metadata reads it,
+`opensysml.__version__` reports the installed distribution's version, and
+`scripts/check_version.py` fails a release whose tag names another version. The
+version tests therefore require the tree under test to be the installed
+distribution — `pip install -e python/`. A wheel of another version installed
+beside the source tree makes them fail with that remedy: the artifact is what is
+stale, not the declaration.
+
+## Generated typed classes
+
+`python -m opensysml.generate model.sysml -o model_types.py` emits one class per
+SysML *definition*, and the generated hierarchy follows the model's
+generalization edges: `specializes`, `subsets` and `redefines` all become base
+classes, because Python has a single notion of inheritance. What tells the two
+apart is the members, not the bases:
+
+- a **redefinition** reuses the redefined feature's name, so its property
+  overrides the base class's property of that name, and takes over the type and
+  multiplicity it does not restate (`attribute :>> mass = 2.0;` stays `float`,
+  and a redefined `0..*` feature stays a `list[...]`);
+- a **subset** under a new name adds a property beside the base class's one, and
+  likewise inherits the type and multiplicity it leaves out.
+
+With **multiple supertypes**, bases are emitted in declaration order, a target
+named twice appearing once, and Python resolves members left to right by its
+usual MRO. A base another declared base already specializes is left implicit —
+`Hybrid :> Vehicle, Electric` where `Electric :> Vehicle` emits
+`class Hybrid(Electric)`, which Python can linearize and which keeps both
+relationships and `Electric`'s properties. Where no order linearizes at all
+(two bases specializing a shared pair in opposite orders), rather than emit a
+module that fails to import, the generator keeps the bases it can and records
+what it left out as a comment on the class, naming the edge:
+
+```python
+class Both(One):
+    # specializes Demo::Two, left out: Python cannot linearize it with the bases above
+```
+
+A base outside the generated model is reported the same way. Both are the model's
+hierarchy being wider than Python's, not facts being discarded — the service
+reports every edge, and `Symbol.specializations` still carries them all.
+
+**Limitation, unchanged:** only structural usages (`attribute`, `part`, `item`,
+`occurrence`, `individual`, `port`, `enum`) become properties. Behavioral and
+connector usages — `action`, `state`, `calc`, `constraint`, `requirement`,
+`connection`, `flow`, `interface`, `allocation`, `case` — are not instance feature values,
+so a generated class has no member for them; reach them through
+`model["Demo::Vehicle"]`, `verify_constraint` and `verify_satisfaction`.
+
+## Names that shadow builtins
+
+Neither builtin name is a live part of the API any more: the module-level
+evaluation function is `opensysml.evaluate`, and the execution error is
+`opensysml.ExecutionError`. `opensysml.eval` and `opensysml.errors.RuntimeError`
+remain as deprecated aliases that warn on use, out of their modules' `__all__`,
+so a star-import binds neither.
+
+```python
+import opensysml
+
+opensysml.evaluate("1 + 2", file_path="model.sysml")   # opensysml.eval warns
+model.eval("mass", subject="Demo::sedan")            # a method shadows nothing
+```
+
+```python
+from opensysml import eval          # shadows the builtin in this module — don't
+```
+
+Guidance for this package and for code around it:
+
+- **Call `opensysml.evaluate`.** `opensysml.eval` still works and returns the same
+  result, warning `DeprecationWarning`; it goes away in 1.0.0.
+- Import the package, not its names, for anything named like a builtin.
+- Catch `opensysml.ExecutionError` (or its base `opensysml.OpenSysMLError`), never
+  `opensysml.errors.RuntimeError`, which warns and is due for removal.
+- Do not name a new public function or exception after a builtin.
+
+0.2.0 therefore publishes `evaluate` as the name to write, with both builtin
+names deprecated rather than removed, so code written against 0.1.x keeps
+running until 1.0.0.
+
+## Running the tests
+
+```bash
+make build                                    # builds bin/sysml-grpc
+pip install -e python/ && pip install pytest pytest-mock
+python -m pytest python/tests/ -q             # service-backed tests skip
+```
+
+Tests that need a service skip when none answers on `localhost:50051` and no
+binary is available to spawn one. Where a service *is* provided — as in CI —
+export `OPENSYSML_REQUIRE_SERVICE=1`, and its absence fails instead of skipping.
+
+## Documentation
+
+- Using the client:
+  [docs/guide/09-python.md](https://github.com/Open-MBEE/OpenSysML/blob/main/docs/guide/09-python.md)
+  — installing the service binary, loading a model, instances, verification, conversion
+  and queries
+- The API surface, generated typed classes, latency and the module map:
+  [docs/reference/python-api.md](https://github.com/Open-MBEE/OpenSysML/blob/main/docs/reference/python-api.md)
+- Installing from source and running the tests:
+  [INSTALL.md](https://github.com/Open-MBEE/OpenSysML/blob/main/python/INSTALL.md)

opensysml-0.3.0/README.md

@@ -0,0 +1,196 @@
+# opensysml
+
+Python client for OpenSysML: parse, inspect and execute SysML v2 models over the
+`sysml-grpc` service.
+
+```bash
+pip install opensysml             # from PyPI, once the first release is published
+pip install -e python/          # or from a checkout, at the repository root
+```
+
+```python
+import opensysml
+
+model = opensysml.load("model.sysml", strict=True)   # raises on error diagnostics
+print(model.eval("1 + 2 * 3"))                     # 7
+
+print(model.eval("mass", subject="Demo::sedan"))   # 1200.0 — that object, not the default
+                                                   # requires the service's evaluate_subject
+                                                   # capability, rather than trusting a
+                                                   # service that would ignore the subject
+
+vehicle = model["Vehicle"]                         # by short name or FQN
+vehicle.attributes()                               # own and inherited, with resolved facts
+inst = model.instantiate("Demo::Vehicle")
+inst.mass                                          # 1500.0 [kg] — a Quantity
+
+model.verify_satisfaction()                        # every assert satisfy … by …
+model.save("model.ttl")                            # RDF Turtle (experimental)
+```
+
+Declarations can be authored from notation strings while preserving the
+untouched source:
+
+```python
+model.edit().add_part_def("", "Vehicle").apply()
+model.edit().add_part("Vehicle", "engine", type="Engine").apply()
+```
+
+Use `opensysml.loads(text, language="kerml")` for inline KerML content.
+
+Every call goes through the `sysml-grpc` service, which `opensysml` starts for you from
+`~/.opensysml/bin/sysml-grpc`; the guide below says how to put it there.
+
+## Service ownership
+
+`opensysml` never stops a service it did not start.
+
+- A connection that finds a healthy service already listening uses it and takes
+  no ownership of it: nothing is recorded, and closing the connection leaves the
+  service running. Whoever started it decides when it stops.
+- A service `opensysml` starts is recorded in
+  `~/.opensysml/sysml-grpc-<port>.pid` (`$OPENSYSML_STATE_DIR` overrides the
+  directory) as the service's pid and process start time, plus the pid and start
+  time of the process that started it. Only that process stops it, and only when
+  the last connection holding it is closed or the interpreter exits.
+- The start times are what authenticate the record: a pid is re-checked against
+  the start time written for it, so a pid the operating system has since reused
+  is treated as a stale record — cleaned up, never signalled. A command line
+  that merely looks like `sysml-grpc` is not identity and is never acted on.
+- A service that crashes leaves a record whose process is gone; the next
+  connection detects that, removes it and starts a service of its own.
+
+## Pinned release digests
+
+A download is verified against `PINNED_SHA256` in `opensysml/binary.py`, which
+pins the SHA-256 of every asset of a release. The `.sha256` served beside a
+binary comes from whoever served the binary, so it detects corruption but not a
+republished release; a pinned digest is independent of that origin. A download
+with no pin fails with a message naming the version, rather than falling back to
+the served checksum — `$OPENSYSML_ALLOW_UNPINNED_DOWNLOAD=<owner/repo>` (or `=1` for
+any repository) accepts same-origin trust explicitly for what it names, with a
+warning.
+
+At release time, after the service binaries are published and final:
+
+```bash
+export GITHUB_TOKEN=...            # the release API rate-limits unauthenticated calls
+python scripts/pin_release_checksums.py --version v0.0.9 --write
+git commit -am 'chore(python): pin release digests for v0.0.9'
+```
+
+The script downloads every `sysml-grpc-*` asset of that release, hashes what it
+downloaded, refuses the release if a `.sha256` sidecar disagrees with the asset
+it describes, and rewrites the table in place. `--check` re-hashes the assets of
+every pinned release and fails on any disagreement, catching a release
+republished with another binary. A opensysml release therefore pins the service
+releases published before it; asking for a newer one needs a newer opensysml (or
+the explicit opt-in above), and leaves an already-downloaded binary serving
+rather than refusing to start — only a digest that *contradicts* a pin is
+treated as tampering and refuses to fall back.
+
+## Version
+
+`opensysml/_version.py` is the only declaration: the packaging metadata reads it,
+`opensysml.__version__` reports the installed distribution's version, and
+`scripts/check_version.py` fails a release whose tag names another version. The
+version tests therefore require the tree under test to be the installed
+distribution — `pip install -e python/`. A wheel of another version installed
+beside the source tree makes them fail with that remedy: the artifact is what is
+stale, not the declaration.
+
+## Generated typed classes
+
+`python -m opensysml.generate model.sysml -o model_types.py` emits one class per
+SysML *definition*, and the generated hierarchy follows the model's
+generalization edges: `specializes`, `subsets` and `redefines` all become base
+classes, because Python has a single notion of inheritance. What tells the two
+apart is the members, not the bases:
+
+- a **redefinition** reuses the redefined feature's name, so its property
+  overrides the base class's property of that name, and takes over the type and
+  multiplicity it does not restate (`attribute :>> mass = 2.0;` stays `float`,
+  and a redefined `0..*` feature stays a `list[...]`);
+- a **subset** under a new name adds a property beside the base class's one, and
+  likewise inherits the type and multiplicity it leaves out.
+
+With **multiple supertypes**, bases are emitted in declaration order, a target
+named twice appearing once, and Python resolves members left to right by its
+usual MRO. A base another declared base already specializes is left implicit —
+`Hybrid :> Vehicle, Electric` where `Electric :> Vehicle` emits
+`class Hybrid(Electric)`, which Python can linearize and which keeps both
+relationships and `Electric`'s properties. Where no order linearizes at all
+(two bases specializing a shared pair in opposite orders), rather than emit a
+module that fails to import, the generator keeps the bases it can and records
+what it left out as a comment on the class, naming the edge:
+
+```python
+class Both(One):
+    # specializes Demo::Two, left out: Python cannot linearize it with the bases above
+```
+
+A base outside the generated model is reported the same way. Both are the model's
+hierarchy being wider than Python's, not facts being discarded — the service
+reports every edge, and `Symbol.specializations` still carries them all.
+
+**Limitation, unchanged:** only structural usages (`attribute`, `part`, `item`,
+`occurrence`, `individual`, `port`, `enum`) become properties. Behavioral and
+connector usages — `action`, `state`, `calc`, `constraint`, `requirement`,
+`connection`, `flow`, `interface`, `allocation`, `case` — are not instance feature values,
+so a generated class has no member for them; reach them through
+`model["Demo::Vehicle"]`, `verify_constraint` and `verify_satisfaction`.
+
+## Names that shadow builtins
+
+Neither builtin name is a live part of the API any more: the module-level
+evaluation function is `opensysml.evaluate`, and the execution error is
+`opensysml.ExecutionError`. `opensysml.eval` and `opensysml.errors.RuntimeError`
+remain as deprecated aliases that warn on use, out of their modules' `__all__`,
+so a star-import binds neither.
+
+```python
+import opensysml
+
+opensysml.evaluate("1 + 2", file_path="model.sysml")   # opensysml.eval warns
+model.eval("mass", subject="Demo::sedan")            # a method shadows nothing
+```
+
+```python
+from opensysml import eval          # shadows the builtin in this module — don't
+```
+
+Guidance for this package and for code around it:
+
+- **Call `opensysml.evaluate`.** `opensysml.eval` still works and returns the same
+  result, warning `DeprecationWarning`; it goes away in 1.0.0.
+- Import the package, not its names, for anything named like a builtin.
+- Catch `opensysml.ExecutionError` (or its base `opensysml.OpenSysMLError`), never
+  `opensysml.errors.RuntimeError`, which warns and is due for removal.
+- Do not name a new public function or exception after a builtin.
+
+0.2.0 therefore publishes `evaluate` as the name to write, with both builtin
+names deprecated rather than removed, so code written against 0.1.x keeps
+running until 1.0.0.
+
+## Running the tests
+
+```bash
+make build                                    # builds bin/sysml-grpc
+pip install -e python/ && pip install pytest pytest-mock
+python -m pytest python/tests/ -q             # service-backed tests skip
+```
+
+Tests that need a service skip when none answers on `localhost:50051` and no
+binary is available to spawn one. Where a service *is* provided — as in CI —
+export `OPENSYSML_REQUIRE_SERVICE=1`, and its absence fails instead of skipping.
+
+## Documentation
+
+- Using the client:
+  [docs/guide/09-python.md](https://github.com/Open-MBEE/OpenSysML/blob/main/docs/guide/09-python.md)
+  — installing the service binary, loading a model, instances, verification, conversion
+  and queries
+- The API surface, generated typed classes, latency and the module map:
+  [docs/reference/python-api.md](https://github.com/Open-MBEE/OpenSysML/blob/main/docs/reference/python-api.md)
+- Installing from source and running the tests:
+  [INSTALL.md](https://github.com/Open-MBEE/OpenSysML/blob/main/python/INSTALL.md)