sysml2py 0.5.2__tar.gz → 1.0.0__tar.gz

sysml2py-1.0.0/.gitignore

@@ -0,0 +1,161 @@
+# 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
+
+# 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/#use-with-ide
+.pdm.toml
+
+# 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/
+.DS_Store

sysml2py-1.0.0/PKG-INFO

@@ -0,0 +1,106 @@
+Metadata-Version: 2.5
+Name: sysml2py
+Version: 1.0.0
+Summary: Autogenerated SysML v2 builder library (generated by sysml2py-lab).
+Project-URL: Homepage, https://github.com/Westfall-io/sysml2py
+Project-URL: Bug Tracker, https://github.com/Westfall-io/sysml2py/issues
+Author: Westfall-io
+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
+Classifier: Development Status :: 4 - Beta
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: astropy>=5.3; extra == 'dev'
+Requires-Dist: pytest>=7.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# sysml2py (generated)
+
+Version **1.0.0** — generated by **sysml2py-lab** from the SysML v2
+grammar + relationship model + corpus (issues #6/#7/#8/#9/#13).
+
+Capabilities:
+- Generated AST node classes per grammar rule
+- Membership-dispatch table from children.json
+- `dump()` / `get_definition()` on every node (loss-minimizing)
+- `Unsupported` nodes carry raw text (zero NotImplementedError)
+- Provenance stamp in `sysml2py.provenance`
+
+## Building a model (friendly builder API)
+
+Friendly names drop the `Builder`/`Usage`/`Definition` suffixes —
+`Part`, `Attribute`, `Item`, ... are builders; usage vs definition is
+chosen at creation via `kind=`; `add()` appends children so a full
+package dumps from nested composition:
+
+```python
+from sysml2py import PackageBuilder, Part, Attribute
+
+pkg = PackageBuilder('MyModel')
+stage = Part('Stage_1')
+stage.add(Attribute('mass'))
+stage.add(Attribute('thrust'))
+pkg.add(stage)
+print(pkg.dump())
+```
+
+```
+package MyModel
+{
+   part Stage_1
+   {
+      attribute mass;
+      attribute thrust;
+   }
+}
+```
+
+Definitions are the same class with `kind=` at creation:
+`Part('Stage_1', kind='definition')` -> `part def Stage_1;`
+
+Kinds without a definition form (`Package`, `Comment`, `Actor`,
+`Reference`, `Transition`, `Import`, `Message`, `Succession`,
+`AliasMember`, `Subject`, `ObjectiveRequirement`) reject
+`kind='definition'` with a `ValueError` — the generator never
+emits a definition it cannot cast back (and a class-name kind
+like `'PartDefinition'` raises
+too, since that would print invalid SysML).
+
+`Package`/`Comment`/`Import`/`Message`/`Succession`/`AliasMember`
+keep the `*Builder` suffix
+(their friendly names are the AST node classes). The classic `*Builder`
+names (`PartUsageBuilder`, ...) remain available.
+
+Value-bearing attributes are supported: `Attribute('mass', value=1000,
+unit='kg')` renders `attribute mass = 1000[kg];`, with the unit imported
+automatically as `public import SI::kg;` (issue #26, lab repo). You may also
+pass an astropy `Quantity` and the unit is derived from it (`value=1000*u.kg`)
+— add `import astropy.units as u` yourself, since the runtime stays
+pure-stdlib (astropy is not bundled; see the migration note).
+
+Compatibility: this is the **1.x** line. Moving from 0.5.x? see
+the migration note:
+https://github.com/Westfall-io/sysml2py-lab/blob/main/docs/migration-0.5-to-1.0.md

sysml2py-1.0.0/README.md

@@ -0,0 +1,67 @@
+# sysml2py (generated)
+
+Version **1.0.0** — generated by **sysml2py-lab** from the SysML v2
+grammar + relationship model + corpus (issues #6/#7/#8/#9/#13).
+
+Capabilities:
+- Generated AST node classes per grammar rule
+- Membership-dispatch table from children.json
+- `dump()` / `get_definition()` on every node (loss-minimizing)
+- `Unsupported` nodes carry raw text (zero NotImplementedError)
+- Provenance stamp in `sysml2py.provenance`
+
+## Building a model (friendly builder API)
+
+Friendly names drop the `Builder`/`Usage`/`Definition` suffixes —
+`Part`, `Attribute`, `Item`, ... are builders; usage vs definition is
+chosen at creation via `kind=`; `add()` appends children so a full
+package dumps from nested composition:
+
+```python
+from sysml2py import PackageBuilder, Part, Attribute
+
+pkg = PackageBuilder('MyModel')
+stage = Part('Stage_1')
+stage.add(Attribute('mass'))
+stage.add(Attribute('thrust'))
+pkg.add(stage)
+print(pkg.dump())
+```
+
+```
+package MyModel
+{
+   part Stage_1
+   {
+      attribute mass;
+      attribute thrust;
+   }
+}
+```
+
+Definitions are the same class with `kind=` at creation:
+`Part('Stage_1', kind='definition')` -> `part def Stage_1;`
+
+Kinds without a definition form (`Package`, `Comment`, `Actor`,
+`Reference`, `Transition`, `Import`, `Message`, `Succession`,
+`AliasMember`, `Subject`, `ObjectiveRequirement`) reject
+`kind='definition'` with a `ValueError` — the generator never
+emits a definition it cannot cast back (and a class-name kind
+like `'PartDefinition'` raises
+too, since that would print invalid SysML).
+
+`Package`/`Comment`/`Import`/`Message`/`Succession`/`AliasMember`
+keep the `*Builder` suffix
+(their friendly names are the AST node classes). The classic `*Builder`
+names (`PartUsageBuilder`, ...) remain available.
+
+Value-bearing attributes are supported: `Attribute('mass', value=1000,
+unit='kg')` renders `attribute mass = 1000[kg];`, with the unit imported
+automatically as `public import SI::kg;` (issue #26, lab repo). You may also
+pass an astropy `Quantity` and the unit is derived from it (`value=1000*u.kg`)
+— add `import astropy.units as u` yourself, since the runtime stays
+pure-stdlib (astropy is not bundled; see the migration note).
+
+Compatibility: this is the **1.x** line. Moving from 0.5.x? see
+the migration note:
+https://github.com/Westfall-io/sysml2py-lab/blob/main/docs/migration-0.5-to-1.0.md

sysml2py-1.0.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling>=1.24.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "sysml2py"
+version = "1.0.0"
+description = "Autogenerated SysML v2 builder library (generated by sysml2py-lab)."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [{ name = "Westfall-io" }]
+license = { file = "LICENSE" }
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dependencies = []
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=7.4",
+  "astropy>=5.3",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/Westfall-io/sysml2py"
+"Bug Tracker" = "https://github.com/Westfall-io/sysml2py/issues"
+
+[tool.hatch.build.targets.sdist]
+# src-layout MUST be preserved in the sdist or `python -m build` (wheel from
+# sdist) produces an EMPTY wheel: hatchling flattens `src/sysml2py` to
+# `sysml2py/` at the sdist root unless the sdist target is given an explicit
+# include.  Keep the src/ prefix (verified against hatchling 1.32.4, issue
+# #13 review W2-3).
+include = ["src/sysml2py/**", "README.md", "pyproject.toml", "LICENSE"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/sysml2py"]
+# NOTE: do NOT add an `include` filter here.  `packages = ["src/sysml2py"]`
+# selects EVERYTHING under that dir.  An `include` list on the wheel target
+# is RESTRICTIVE and silently empties the wheel; keep package-data selection
+# implicit.
+
+# Formatting config is pinned here (NOT discovered by walking up), so ruff /
+# black agree with `_ruff_format` regardless of where the tree is generated.
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.black]
+line-length = 100
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]