sysmlpy 0.1.0__tar.gz

sysmlpy-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Westfall-io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

sysmlpy-0.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: sysmlpy
+Version: 0.1.0
+Summary: SysML v2.0 Parser
+License: MIT License
+         
+         Copyright (c) 2023 Westfall-io
+         
+         Permission is hereby granted, free of charge, to any person obtaining a copy
+         of this software and associated documentation files (the "Software"), to deal
+         in the Software without restriction, including without limitation the rights
+         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+         copies of the Software, and to permit persons to whom the Software is
+         furnished to do so, subject to the following conditions:
+         
+         The above copyright notice and this permission notice shall be included in all
+         copies or substantial portions of the Software.
+         
+         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+         SOFTWARE.
+License-File: LICENSE
+Author: Jon R. Fox (mycr0ft)
+Author-email: jon.fox@drfox.com
+Requires-Python: >=3.7
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Provides-Extra: graph
+Requires-Dist: antlr4-python3-runtime (>=4.13)
+Requires-Dist: networkx (>=3.0) ; extra == "graph"
+Requires-Dist: pint (>=0.24)
+Requires-Dist: pyyaml (>=6.0)
+Project-URL: Bug Tracker, https://github.com/Westfall-io/sysmlpy/issues
+Project-URL: Homepage, https://github.com/Westfall-io/sysmlpy
+Description-Content-Type: text/markdown
+
+# sysmlpy
+[![PyPI version](https://badge.fury.io/py/sysmlpy.svg)](https://badge.fury.io/py/sysmlpy)[![PyPI status](https://img.shields.io/pypi/status/sysmlpy.svg)](https://pypi.python.org/pypi/sysmlpy/)[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
+
+## Description
+sysmlpy is an open source pure Python library for constructing python-based
+classes consistent with the [SysML v2.0 standard](https://github.com/Systems-Modeling/SysML-v2-Release).
+
+This project began as a fork of the sysml2py project by [Christopher
+Cox](https://github.com/chriscox-westfall). Since April 2026 [Jon Fox](mailto:jon.fox@drfox.com) 
+decided to complete coverage of all SysMLv2 features over two months of weekends,
+and dropped the textX parser in favor of [an ANTLR4 parser grammar](https://github.com/daltskin/sysml-v2-grammar) and
+changed our unit library to pint.
+The project had diverged so much from sysml2py that a new name, sysmlpy, was selected.
+
+![Lines of Code Over Time](loc_history.svg)
+
+**v0.12.0:** 100% conformance test pass rate (123/123). Storage abstraction layer with in-memory and NetworkX graph backends. Convenience functions: find_all, count, traverse, to_dict, to_graph, path_between.
+
+## Requirements
+sysmlpy requires the following Python packages:
+- [pyyaml](https://github.com/yaml/pyyaml)
+- [pint](https://github.com/hgrecco/pint)
+- [antlr4-python3-runtime](https://github.com/antlr/antlr4)
+
+### Optional Dependencies
+- [networkx](https://networkx.org/) — graph analysis backend (install with `pip install sysmlpy[graph]`)
+
+## Installation
+
+Multiple installation methods are supported by sysmlpy, including:
+
+|                             **Logo**                              | **Platform** |                                    **Command**                                    |
+|:-----------------------------------------------------------------:|:------------:|:---------------------------------------------------------------------------------:|
+|       ![PyPI logo](https://simpleicons.org/icons/pypi.svg)        |     PyPI     |                        ``python -m pip install sysmlpy``                        |
+|       ![PyPI logo](https://simpleicons.org/icons/pypi.svg)        |     PyPI     |                 ``python -m pip install sysmlpy[graph]`` (with graph analysis)                  |
+|     ![GitHub logo](https://simpleicons.org/icons/github.svg)      |    GitHub    | ``python -m pip install https://github.com/mycr0ft/sysmlpy/archive/refs/heads/main.zip`` |
+
+## Documentation
+
+Documentation can be found [here.](https://mycr0ft.github.io/sysmlpy/)
+
+### Basic Usage
+
+The code below will create a part called Stage 1, with a shortname of <'3.1'>
+referencing a specific requirement or document. It has a mass attribute of 100
+kg. It has a thrust attribute of 1000 N. These attributes are created and placed
+as a child of the part. Next, we recall the part value for thrust and add 199 N.
+Finally, we can dump the output from this class.
+```
+  from sysmlpy import Attribute, Part, ureg
+
+  a = Attribute(name='mass')
+  a.set_value(100 * ureg.kilogram)
+  b = Attribute(name='thrust')
+  b.set_value(1000 * ureg.newton)
+  c = Part(name="Stage_1", shortname="'3.1'")
+  c._set_child(a)
+  c._set_child(b)
+  v = "Stage_1.thrust"
+  c._get_child(v).set_value(c._get_child(v).get_value() + 199 * ureg.newton)
+  print(c.dump())
+```
+
+It will output the following:
+```
+  part <'3.1'> Stage_1 {
+    attribute mass= 100 [kilogram];
+    attribute thrust= 1199.0 [newton];
+  }
+```
+
+The package is able to handle Items, Parts, and Attributes.
+
+```
+a = Part(name='camera')
+b = Item(name='lens')
+d = Attribute(name='mass')
+c = Part(name='sensor')
+c._set_child(a)
+c._set_child(b)
+a._set_child(d)
+print(c.dump())
+```
+
+will return:
+```
+part sensor {
+   part camera {
+      attribute mass;
+   }
+   item lens;
+}
+```
+
+Actions
+-------
+
+Actions (activities) can be defined with input and output parameters::
+
+```
+from sysmlpy import Action
+
+# Action definition with typed inputs/outputs
+a = Action(definition=True, name='Focus')
+a.add_input('scene', 'Scene')
+a.add_output('image', 'Image')
+print(a.dump())
+# → action def Focus { in scene : Scene; out image : Image; }
+
+# Action usage with references
+b = Action(name='TakePicture')
+b.add_input('scene')
+b.add_output('picture')
+print(b.dump())
+# → action TakePicture { in scene; out picture; }
+```
+
+References
+----------
+
+References can reference other elements::
+
+```
+from sysmlpy import Reference, Item
+
+# Simple reference
+r = Reference(name='driver')
+print(r.dump())
+# → ref driver;
+
+# Reference with type
+person = Item(name='Person')
+r2 = Reference(name='driver')
+r2.set_type(person)
+print(r2.dump())
+# → ref driver : Person;
+
+# Reference redefinition
+r3 = Reference(name='payload', redefines=True)
+r3.set_type(person)
+print(r3.dump())
+# → ref :>> payload : Person;
+```
+
+## Grammar Round-Trip
+
+`loads()` parses SysML v2 text and `classtree()` converts the result back to text. This round-trip is the basis for the grammar test suite.
+
+```python
+from sysmlpy import loads
+from sysmlpy.formatting import classtree
+
+text = """package 'Action Example' {
+    action def Focus { in scene : Scene; out image : Image; }
+    action def Shoot { in image: Image; out picture : Picture; }
+
+    action def TakePicture {
+        in item scene : Scene;
+        out item picture : Picture;
+
+        bind focus.scene = scene;
+
+        action focus : Focus { in scene; out image; }
+
+        flow focus.image to shoot.image;
+
+        first focus then shoot;
+
+        action shoot : Shoot { in image; out picture; }
+
+        bind shoot.picture = picture;
+    }
+}"""
+
+model = loads(text)
+tree = classtree(model)
+print(tree.dump())
+```
+
+**61% of the 56 grammar round-trip tests currently pass** (34/56), covering packages, parts, items, ports, interfaces, binding connectors, flow connections, all action forms (definition, shorthand, succession, decomposition), expressions, calculations, and constraints.
+
+## Conformance
+
+**100% of 123 OMG XPect conformance tests pass** (123/123).
+
+## License
+sysmlpy is released under the MIT license, hence allowing commercial use of the library.
+

sysmlpy-0.1.0/README.md

@@ -0,0 +1,187 @@
+# sysmlpy
+[![PyPI version](https://badge.fury.io/py/sysmlpy.svg)](https://badge.fury.io/py/sysmlpy)[![PyPI status](https://img.shields.io/pypi/status/sysmlpy.svg)](https://pypi.python.org/pypi/sysmlpy/)[![MIT license](https://img.shields.io/badge/License-MIT-blue.svg)](https://lbesson.mit-license.org/)
+
+## Description
+sysmlpy is an open source pure Python library for constructing python-based
+classes consistent with the [SysML v2.0 standard](https://github.com/Systems-Modeling/SysML-v2-Release).
+
+This project began as a fork of the sysml2py project by [Christopher
+Cox](https://github.com/chriscox-westfall). Since April 2026 [Jon Fox](mailto:jon.fox@drfox.com) 
+decided to complete coverage of all SysMLv2 features over two months of weekends,
+and dropped the textX parser in favor of [an ANTLR4 parser grammar](https://github.com/daltskin/sysml-v2-grammar) and
+changed our unit library to pint.
+The project had diverged so much from sysml2py that a new name, sysmlpy, was selected.
+
+![Lines of Code Over Time](loc_history.svg)
+
+**v0.12.0:** 100% conformance test pass rate (123/123). Storage abstraction layer with in-memory and NetworkX graph backends. Convenience functions: find_all, count, traverse, to_dict, to_graph, path_between.
+
+## Requirements
+sysmlpy requires the following Python packages:
+- [pyyaml](https://github.com/yaml/pyyaml)
+- [pint](https://github.com/hgrecco/pint)
+- [antlr4-python3-runtime](https://github.com/antlr/antlr4)
+
+### Optional Dependencies
+- [networkx](https://networkx.org/) — graph analysis backend (install with `pip install sysmlpy[graph]`)
+
+## Installation
+
+Multiple installation methods are supported by sysmlpy, including:
+
+|                             **Logo**                              | **Platform** |                                    **Command**                                    |
+|:-----------------------------------------------------------------:|:------------:|:---------------------------------------------------------------------------------:|
+|       ![PyPI logo](https://simpleicons.org/icons/pypi.svg)        |     PyPI     |                        ``python -m pip install sysmlpy``                        |
+|       ![PyPI logo](https://simpleicons.org/icons/pypi.svg)        |     PyPI     |                 ``python -m pip install sysmlpy[graph]`` (with graph analysis)                  |
+|     ![GitHub logo](https://simpleicons.org/icons/github.svg)      |    GitHub    | ``python -m pip install https://github.com/mycr0ft/sysmlpy/archive/refs/heads/main.zip`` |
+
+## Documentation
+
+Documentation can be found [here.](https://mycr0ft.github.io/sysmlpy/)
+
+### Basic Usage
+
+The code below will create a part called Stage 1, with a shortname of <'3.1'>
+referencing a specific requirement or document. It has a mass attribute of 100
+kg. It has a thrust attribute of 1000 N. These attributes are created and placed
+as a child of the part. Next, we recall the part value for thrust and add 199 N.
+Finally, we can dump the output from this class.
+```
+  from sysmlpy import Attribute, Part, ureg
+
+  a = Attribute(name='mass')
+  a.set_value(100 * ureg.kilogram)
+  b = Attribute(name='thrust')
+  b.set_value(1000 * ureg.newton)
+  c = Part(name="Stage_1", shortname="'3.1'")
+  c._set_child(a)
+  c._set_child(b)
+  v = "Stage_1.thrust"
+  c._get_child(v).set_value(c._get_child(v).get_value() + 199 * ureg.newton)
+  print(c.dump())
+```
+
+It will output the following:
+```
+  part <'3.1'> Stage_1 {
+    attribute mass= 100 [kilogram];
+    attribute thrust= 1199.0 [newton];
+  }
+```
+
+The package is able to handle Items, Parts, and Attributes.
+
+```
+a = Part(name='camera')
+b = Item(name='lens')
+d = Attribute(name='mass')
+c = Part(name='sensor')
+c._set_child(a)
+c._set_child(b)
+a._set_child(d)
+print(c.dump())
+```
+
+will return:
+```
+part sensor {
+   part camera {
+      attribute mass;
+   }
+   item lens;
+}
+```
+
+Actions
+-------
+
+Actions (activities) can be defined with input and output parameters::
+
+```
+from sysmlpy import Action
+
+# Action definition with typed inputs/outputs
+a = Action(definition=True, name='Focus')
+a.add_input('scene', 'Scene')
+a.add_output('image', 'Image')
+print(a.dump())
+# → action def Focus { in scene : Scene; out image : Image; }
+
+# Action usage with references
+b = Action(name='TakePicture')
+b.add_input('scene')
+b.add_output('picture')
+print(b.dump())
+# → action TakePicture { in scene; out picture; }
+```
+
+References
+----------
+
+References can reference other elements::
+
+```
+from sysmlpy import Reference, Item
+
+# Simple reference
+r = Reference(name='driver')
+print(r.dump())
+# → ref driver;
+
+# Reference with type
+person = Item(name='Person')
+r2 = Reference(name='driver')
+r2.set_type(person)
+print(r2.dump())
+# → ref driver : Person;
+
+# Reference redefinition
+r3 = Reference(name='payload', redefines=True)
+r3.set_type(person)
+print(r3.dump())
+# → ref :>> payload : Person;
+```
+
+## Grammar Round-Trip
+
+`loads()` parses SysML v2 text and `classtree()` converts the result back to text. This round-trip is the basis for the grammar test suite.
+
+```python
+from sysmlpy import loads
+from sysmlpy.formatting import classtree
+
+text = """package 'Action Example' {
+    action def Focus { in scene : Scene; out image : Image; }
+    action def Shoot { in image: Image; out picture : Picture; }
+
+    action def TakePicture {
+        in item scene : Scene;
+        out item picture : Picture;
+
+        bind focus.scene = scene;
+
+        action focus : Focus { in scene; out image; }
+
+        flow focus.image to shoot.image;
+
+        first focus then shoot;
+
+        action shoot : Shoot { in image; out picture; }
+
+        bind shoot.picture = picture;
+    }
+}"""
+
+model = loads(text)
+tree = classtree(model)
+print(tree.dump())
+```
+
+**61% of the 56 grammar round-trip tests currently pass** (34/56), covering packages, parts, items, ports, interfaces, binding connectors, flow connections, all action forms (definition, shorthand, succession, decomposition), expressions, calculations, and constraints.
+
+## Conformance
+
+**100% of 123 OMG XPect conformance tests pass** (123/123).
+
+## License
+sysmlpy is released under the MIT license, hence allowing commercial use of the library.

sysmlpy-0.1.0/pyproject.toml

@@ -0,0 +1,136 @@
+[build-system]
+#requires = ["setuptools>=61.0"]
+#build-backend = "setuptools.build_meta"
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[project]
+name = "sysmlpy"
+version = "0.1.0"
+description = "SysML v2.0 Parser"
+authors = [
+  { name="Jon R. Fox (mycr0ft)", email="jon.fox@drfox.com" },
+]
+readme = "README.md"
+license = {file = "LICENSE"}
+requires-python = ">=3.7"
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/Westfall-io/sysmlpy"
+"Bug Tracker" = "https://github.com/Westfall-io/sysmlpy/issues"
+
+
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src/sysmlpy", "src"]
+
+[tool.setuptools.package-data]
+grammar = ["*.tx"]
+"sysmlpy" = [
+    "library/**/*.sysml",
+    "library/**/*.kerml",
+    "library/LICENSE",
+]
+
+
+[tool.pytest.ini_options]
+pythonpath = [
+  "src"
+]
+markers = [
+    "conformance: SysML v2 Pilot Implementation 2026-03 parse conformance tests (deselect with '-m not conformance')",
+]
+
+
+[tool.semantic_release]
+version_variable = [
+    "src/sysmlpy/__init__.py:version",
+]
+version_toml=[
+    "pyproject.toml:tool.poetry.version",
+    "pyproject.toml:project.version",
+]
+commit_parser = "emoji"
+build_command = "pip install poetry && poetry build"
+commit_message = ":bookmark:{version}\n\nAutomatically generated by python-semantic-release"
+
+[tool.semantic_release.changelog]
+exclude_commit_patterns = [":robot:",":twisted_rightwards_arrows:",
+":poop:", "^[^:].*"]
+
+[tool.semantic_release.commit_parser_options]
+major_tags = [":boom:"]
+minor_tags = [
+    ":sparkles:",
+    ":children_crossing:",
+    ":lipstick:",
+    ":iphone:",
+    ":egg:",
+    ":chart_with_upwards_trend:",
+]
+patch_tags = [
+    ":ambulance:",
+    ":lock:",
+    ":bug:",
+    ":zap:",
+    ":goal_net:",
+    ":alien:",
+    ":wheelchair:",
+    ":speech_balloon:",
+    ":mag:",
+    ":apple:",
+    ":penguin:",
+    ":checkered_flag:",
+    ":robot:",
+    ":green_apple:",
+    ":memo:",
+    ":heavy_plus_sign:",
+    ":construction:",
+    ":white_check_mark:",
+]
+
+[tool.semantic_release.branches.main]
+match = "(main|master)"
+prerelease = false
+build_command = "pip install poetry && poetry build"
+
+[tool.semantic_release.branches."dev0.5.x"]
+match = "dev0.5.x"
+prerelease = true
+prerelease_token = "rc"
+build_command = "pip install poetry && poetry build"
+
+
+[tool.poetry]
+name = "sysmlpy"
+version = "0.1.0"
+description = ""
+authors = ["Jon R. Fox (mycr0ft) <jon.fox@drfox.com>"]
+readme = "README.md"
+packages = [{ include = "sysmlpy", from = "src" }]
+
+[tool.poetry.dependencies]
+python = "^3.9"
+pint = ">=0.24"
+pyyaml = ">=6.0"
+antlr4-python3-runtime = ">=4.13"
+networkx = { version = ">=3.0", optional = true }
+
+[tool.poetry.extras]
+graph = ["networkx"]
+
+[tool.poetry.scripts]
+sysmlpy = "sysmlpy.__main__:main"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">=8.0,<9.0"
+