sysml2kit 0.0.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- sysml2kit-0.0.1/.gitignore +34 -0
- sysml2kit-0.0.1/.pre-commit-config.yaml +39 -0
- sysml2kit-0.0.1/.python-version +1 -0
- sysml2kit-0.0.1/CHANGELOG.md +12 -0
- sysml2kit-0.0.1/CITATION.cff +16 -0
- sysml2kit-0.0.1/CLAUDE.md +69 -0
- sysml2kit-0.0.1/CONTRIBUTING.md +40 -0
- sysml2kit-0.0.1/LICENSE +202 -0
- sysml2kit-0.0.1/NOTICE +10 -0
- sysml2kit-0.0.1/PKG-INFO +166 -0
- sysml2kit-0.0.1/README.md +130 -0
- sysml2kit-0.0.1/SECURITY.md +21 -0
- sysml2kit-0.0.1/SPEC.md +65 -0
- sysml2kit-0.0.1/docs/index.md +19 -0
- sysml2kit-0.0.1/mkdocs.yml +33 -0
- sysml2kit-0.0.1/pyproject.toml +170 -0
- sysml2kit-0.0.1/scripts/slopcheck.sh +103 -0
- sysml2kit-0.0.1/src/sysml2kit/__init__.py +14 -0
- sysml2kit-0.0.1/src/sysml2kit/_version.py +24 -0
- sysml2kit-0.0.1/src/sysml2kit/cli.py +26 -0
- sysml2kit-0.0.1/src/sysml2kit/interchange/__init__.py +13 -0
- sysml2kit-0.0.1/src/sysml2kit/interchange/reader.py +106 -0
- sysml2kit-0.0.1/src/sysml2kit/interchange/typemap.py +62 -0
- sysml2kit-0.0.1/src/sysml2kit/interchange/writer.py +73 -0
- sysml2kit-0.0.1/src/sysml2kit/model/__init__.py +59 -0
- sysml2kit-0.0.1/src/sysml2kit/model/analysis.py +17 -0
- sysml2kit-0.0.1/src/sysml2kit/model/base.py +73 -0
- sysml2kit-0.0.1/src/sysml2kit/model/builder.py +239 -0
- sysml2kit-0.0.1/src/sysml2kit/model/container.py +220 -0
- sysml2kit-0.0.1/src/sysml2kit/model/metadata.py +19 -0
- sysml2kit-0.0.1/src/sysml2kit/model/relations.py +26 -0
- sysml2kit-0.0.1/src/sysml2kit/model/requirements.py +23 -0
- sysml2kit-0.0.1/src/sysml2kit/model/structure.py +60 -0
- sysml2kit-0.0.1/src/sysml2kit/model/values.py +31 -0
- sysml2kit-0.0.1/src/sysml2kit/py.typed +0 -0
- sysml2kit-0.0.1/src/sysml2kit/units.py +60 -0
- sysml2kit-0.0.1/tests/test_package.py +15 -0
- sysml2kit-0.0.1/tools/conformance/run_oracle.py +70 -0
- sysml2kit-0.0.1/uv.lock +1731 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Private working notes
|
|
2
|
+
*.local.md
|
|
3
|
+
|
|
4
|
+
# Python
|
|
5
|
+
__pycache__/
|
|
6
|
+
*.py[cod]
|
|
7
|
+
*.egg-info/
|
|
8
|
+
dist/
|
|
9
|
+
build/
|
|
10
|
+
.venv
|
|
11
|
+
src/sysml2kit/_version.py
|
|
12
|
+
|
|
13
|
+
# Tooling caches
|
|
14
|
+
.mypy_cache/
|
|
15
|
+
.ruff_cache/
|
|
16
|
+
.pytest_cache/
|
|
17
|
+
.hypothesis/
|
|
18
|
+
.coverage
|
|
19
|
+
coverage.xml
|
|
20
|
+
htmlcov/
|
|
21
|
+
|
|
22
|
+
# Docs build
|
|
23
|
+
site/
|
|
24
|
+
|
|
25
|
+
# Editors / OS
|
|
26
|
+
.DS_Store
|
|
27
|
+
.idea/
|
|
28
|
+
.vscode/
|
|
29
|
+
|
|
30
|
+
# slopcheck local venv (legacy pattern; the script uses uvx)
|
|
31
|
+
scripts/.slopvenv/
|
|
32
|
+
|
|
33
|
+
# Conformance oracle downloads (EPL-2.0 material stays out of the repo)
|
|
34
|
+
tools/conformance/.cache/
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
ci:
|
|
2
|
+
autoupdate_schedule: monthly
|
|
3
|
+
|
|
4
|
+
repos:
|
|
5
|
+
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
6
|
+
rev: v6.0.0
|
|
7
|
+
hooks:
|
|
8
|
+
- id: check-added-large-files
|
|
9
|
+
- id: check-merge-conflict
|
|
10
|
+
- id: check-toml
|
|
11
|
+
- id: check-yaml
|
|
12
|
+
- id: end-of-file-fixer
|
|
13
|
+
- id: mixed-line-ending
|
|
14
|
+
- id: trailing-whitespace
|
|
15
|
+
|
|
16
|
+
- repo: https://github.com/astral-sh/ruff-pre-commit
|
|
17
|
+
rev: v0.16.1
|
|
18
|
+
hooks:
|
|
19
|
+
- id: ruff-check
|
|
20
|
+
args: [--fix]
|
|
21
|
+
- id: ruff-format
|
|
22
|
+
|
|
23
|
+
- repo: https://github.com/pre-commit/mirrors-mypy
|
|
24
|
+
rev: v1.18.2
|
|
25
|
+
hooks:
|
|
26
|
+
- id: mypy
|
|
27
|
+
files: ^src/
|
|
28
|
+
additional_dependencies:
|
|
29
|
+
- pydantic>=2.7
|
|
30
|
+
- typer>=0.12
|
|
31
|
+
- httpx>=0.27
|
|
32
|
+
|
|
33
|
+
- repo: https://github.com/jman4162/slopscore
|
|
34
|
+
rev: v0.9.1
|
|
35
|
+
hooks:
|
|
36
|
+
- id: slopscore-lint
|
|
37
|
+
args: ["--profile", "technical", "--fail-on", "high"]
|
|
38
|
+
files: '\.(md|py)$'
|
|
39
|
+
exclude: '^src/sysml2kit/_version\.py$'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.12
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## Unreleased
|
|
4
|
+
|
|
5
|
+
- Core object model (pragmatic profile), builder API, JSON interchange,
|
|
6
|
+
textual writer, traceability queries, validation rules, diff, API client,
|
|
7
|
+
sysmlpy parse backend, CLI.
|
|
8
|
+
|
|
9
|
+
## 0.0.1 — 2026-08-21
|
|
10
|
+
|
|
11
|
+
- Package skeleton published to claim the PyPI name. Importable, no usable
|
|
12
|
+
functionality yet.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
message: "If you use this software, please cite it as below."
|
|
3
|
+
title: "sysml2kit: API-first Python tooling for SysML v2 models"
|
|
4
|
+
authors:
|
|
5
|
+
- family-names: Hodge
|
|
6
|
+
given-names: John
|
|
7
|
+
email: jah70@vt.edu
|
|
8
|
+
license: Apache-2.0
|
|
9
|
+
repository-code: "https://github.com/jman4162/sysml2kit"
|
|
10
|
+
url: "https://github.com/jman4162/sysml2kit"
|
|
11
|
+
keywords:
|
|
12
|
+
- sysml
|
|
13
|
+
- mbse
|
|
14
|
+
- systems-engineering
|
|
15
|
+
- requirements
|
|
16
|
+
- traceability
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
`sysml2kit` is an Apache-2.0 Python toolkit for building, querying, validating,
|
|
8
|
+
and automating SysML v2 models. It is domain-general: no RF/antenna types in
|
|
9
|
+
the API. Domain content lives in the companion repo `sysml2kit-rf-library`.
|
|
10
|
+
Positioning: the requirements/architecture/traceability layer above
|
|
11
|
+
`phased-array-systems` in the agentic RF design stack.
|
|
12
|
+
|
|
13
|
+
Reference spec: OMG `SysML-v2-Release` tag `2026-05` (pinned in SPEC.md).
|
|
14
|
+
The kit implements a documented ~20-element "pragmatic profile" plus an
|
|
15
|
+
`OpaqueElement` passthrough — never claim full abstract-syntax coverage.
|
|
16
|
+
|
|
17
|
+
## Commands
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
uv sync --all-extras --group dev # set up
|
|
21
|
+
uv run pytest # core suite (markers parse/api/conformance excluded by -m in CI)
|
|
22
|
+
uv run pytest -m parse # needs the sysmlpy extra (installed via --all-extras)
|
|
23
|
+
uv run pytest tests/test_model.py -k name # single test
|
|
24
|
+
uv run ruff check . && uv run ruff format --check .
|
|
25
|
+
uv run mypy
|
|
26
|
+
scripts/slopcheck.sh # prose lint (advisory; --strict for CI behavior)
|
|
27
|
+
uv run mkdocs build --strict # docs
|
|
28
|
+
pre-commit run --all-files
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Release: tag `vX.Y.Z` and push; `release.yml` publishes to PyPI via Trusted
|
|
32
|
+
Publishing (environment `pypi`). Version comes from git tags (hatch-vcs);
|
|
33
|
+
never edit `_version.py` or add a version literal.
|
|
34
|
+
|
|
35
|
+
## Architecture
|
|
36
|
+
|
|
37
|
+
- `model/` — pydantic element classes (structure, requirements, relations,
|
|
38
|
+
analysis, metadata), `Ref` (UUID cross-references, never direct object
|
|
39
|
+
refs), `Model` container (identity/ownership registry, `assign_stable_ids()`
|
|
40
|
+
for diffable exports), `builder` (fluent authoring API).
|
|
41
|
+
- `text/` — deterministic `.sysml` writer. There is NO parser in this repo by
|
|
42
|
+
design; parsing goes through `backends/` (sysmlpy behind the `[parse]`
|
|
43
|
+
extra). Do not add grammar code.
|
|
44
|
+
- `interchange/` — Systems Modeling API JSON reader/writer; `typemap.py` is
|
|
45
|
+
the single point of spec-version coupling. Unknown `@type` → `OpaqueElement`
|
|
46
|
+
with the raw record preserved.
|
|
47
|
+
- `query.py` / `validation.py` (rule ids `S2K001…`) / `diff.py`.
|
|
48
|
+
- `api/` — hand-written httpx client for the Systems Modeling API. Do not
|
|
49
|
+
introduce generated clients (the official generated one is LGPL).
|
|
50
|
+
- `interop/` — `RequirementSpec` extraction; the `metricKey` attribute
|
|
51
|
+
convention bridges to phased-array-systems and aedl (adapters live in those
|
|
52
|
+
repos, not here).
|
|
53
|
+
- `cli.py` — typer app. MCP is deferred to v0.2; when added it goes in
|
|
54
|
+
`src/sysml2kit/mcp/` following apab's `docs/mcp-conventions.md`.
|
|
55
|
+
|
|
56
|
+
## Constraints
|
|
57
|
+
|
|
58
|
+
- **License hygiene**: never paste code or model text from the OMG
|
|
59
|
+
pilot-implementation / Release repos (EPL-2.0) into this Apache-2.0 repo.
|
|
60
|
+
The conformance oracle (`tools/conformance/`) downloads the pilot jar at CI
|
|
61
|
+
runtime and runs it out of process only.
|
|
62
|
+
- **Prose rule**: every piece of prose (README, docs, docstrings, commit
|
|
63
|
+
messages) must pass `scripts/slopcheck.sh` (slopscore-lint, profile
|
|
64
|
+
`technical`). Invoke slopscore via `uvx --from slopscore-lint slopscore-lint`
|
|
65
|
+
— the pyenv-shimmed global install is stale.
|
|
66
|
+
- Commit as John Hodge / jman4162 / jhodge007@gmail.com (never jah70@vt.edu).
|
|
67
|
+
- macOS/iCloud gotcha: symlink `.venv → ~/.venvs/sysml2kit`; a real `.venv`
|
|
68
|
+
under `~/Documents` breaks editable installs when iCloud hides `.pth` files.
|
|
69
|
+
- `*.local.md` files are private notes and stay untracked.
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
## Setup
|
|
4
|
+
|
|
5
|
+
```bash
|
|
6
|
+
git clone git@github.com:jman4162/sysml2kit.git
|
|
7
|
+
cd sysml2kit
|
|
8
|
+
uv sync --all-extras --group dev
|
|
9
|
+
pre-commit install
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Checks that gate a merge
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
uv run pytest
|
|
16
|
+
uv run ruff check . && uv run ruff format --check .
|
|
17
|
+
uv run mypy
|
|
18
|
+
uv run mkdocs build --strict
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
`scripts/slopcheck.sh` (prose lint) is advisory; review its findings but a
|
|
22
|
+
merge is never gated on it.
|
|
23
|
+
|
|
24
|
+
## License hygiene
|
|
25
|
+
|
|
26
|
+
This repo is Apache-2.0. The OMG pilot implementation and the
|
|
27
|
+
`SysML-v2-Release` repository (including the normative model libraries and
|
|
28
|
+
grammar files) are EPL-2.0. **Do not paste code, grammar text, or model-library
|
|
29
|
+
text from those repositories into this one.** The conformance workflow runs
|
|
30
|
+
the pilot jar out of process and never commits it. Reference standard library
|
|
31
|
+
symbols (ISQ, SI) by import name only.
|
|
32
|
+
|
|
33
|
+
## Conventions
|
|
34
|
+
|
|
35
|
+
- Version comes from git tags via hatch-vcs; never hand-edit a version.
|
|
36
|
+
- Parsing goes through `sysml2kit.backends`; no grammar code in this repo.
|
|
37
|
+
- `interchange/typemap.py` is the only module allowed to hard-code spec
|
|
38
|
+
`@type` strings.
|
|
39
|
+
- Validation rules get the next free `S2K` id and a docs entry.
|
|
40
|
+
- New public API needs a docstring, a test, and a docs mention in the same PR.
|
sysml2kit-0.0.1/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
sysml2kit-0.0.1/NOTICE
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
sysml2kit
|
|
2
|
+
Copyright 2026 John Hodge
|
|
3
|
+
|
|
4
|
+
This product includes software developed by John Hodge
|
|
5
|
+
(https://github.com/jman4162/sysml2kit).
|
|
6
|
+
|
|
7
|
+
SysML is a registered trademark of the Object Management Group, Inc.
|
|
8
|
+
This project is an independent implementation and is not affiliated with
|
|
9
|
+
or endorsed by OMG. It contains no code or model text from the EPL-2.0
|
|
10
|
+
licensed OMG SysML v2 pilot implementation or release repositories.
|
sysml2kit-0.0.1/PKG-INFO
ADDED
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sysml2kit
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: API-first Python tooling for building, querying, validating, and automating SysML v2 models
|
|
5
|
+
Project-URL: Homepage, https://github.com/jman4162/sysml2kit
|
|
6
|
+
Project-URL: Source, https://github.com/jman4162/sysml2kit
|
|
7
|
+
Project-URL: Issues, https://github.com/jman4162/sysml2kit/issues
|
|
8
|
+
Project-URL: Changelog, https://github.com/jman4162/sysml2kit/blob/main/CHANGELOG.md
|
|
9
|
+
Author-email: John Hodge <jhodge007@gmail.com>
|
|
10
|
+
Maintainer-email: John Hodge <jhodge007@gmail.com>
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
License-File: NOTICE
|
|
14
|
+
Keywords: kerml,mbse,model-based-engineering,omg,requirements,sysml,sysml-v2,systems-engineering,traceability
|
|
15
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Intended Audience :: Science/Research
|
|
18
|
+
Classifier: Operating System :: OS Independent
|
|
19
|
+
Classifier: Programming Language :: Python :: 3
|
|
20
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Topic :: Scientific/Engineering
|
|
24
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
25
|
+
Classifier: Typing :: Typed
|
|
26
|
+
Requires-Python: >=3.11
|
|
27
|
+
Requires-Dist: httpx>=0.27
|
|
28
|
+
Requires-Dist: pint>=0.24
|
|
29
|
+
Requires-Dist: pydantic>=2.7
|
|
30
|
+
Requires-Dist: typer>=0.12
|
|
31
|
+
Provides-Extra: graph
|
|
32
|
+
Requires-Dist: networkx>=3.2; extra == 'graph'
|
|
33
|
+
Provides-Extra: parse
|
|
34
|
+
Requires-Dist: sysmlpy<0.37,>=0.36.2; extra == 'parse'
|
|
35
|
+
Description-Content-Type: text/markdown
|
|
36
|
+
|
|
37
|
+
# sysml2kit
|
|
38
|
+
|
|
39
|
+
[](https://github.com/jman4162/sysml2kit/actions/workflows/ci.yml)
|
|
40
|
+
[](https://pypi.org/project/sysml2kit/)
|
|
41
|
+
[](https://pypi.org/project/sysml2kit/)
|
|
42
|
+
[](LICENSE)
|
|
43
|
+
|
|
44
|
+
API-first Python tooling for building, querying, validating, and automating
|
|
45
|
+
SysML v2 models.
|
|
46
|
+
|
|
47
|
+
> **Status: pre-alpha.** The 0.0.x releases claim the package name and publish
|
|
48
|
+
> the skeleton while the core lands. Pin an exact version if you depend on it.
|
|
49
|
+
|
|
50
|
+
`sysml2kit` is the requirements/architecture/traceability layer for
|
|
51
|
+
engineering automation stacks: build a system model in Python, emit standard
|
|
52
|
+
SysML v2 textual notation and Systems Modeling API JSON, run traceability
|
|
53
|
+
queries (which requirements are unsatisfied? unverified? allocated where?),
|
|
54
|
+
validate, and diff. It targets the OMG SysML v2 standard, not any vendor tool.
|
|
55
|
+
|
|
56
|
+
## What it does
|
|
57
|
+
|
|
58
|
+
- **Object model**: a documented subset of SysML v2 (packages, parts, ports,
|
|
59
|
+
attributes with units, requirements, satisfy/verify/derive/allocate,
|
|
60
|
+
analysis cases) as pydantic models, with an opaque passthrough for elements
|
|
61
|
+
outside the subset so richer models survive a round trip.
|
|
62
|
+
- **Textual notation writer**: deterministic `.sysml` output. Parsing is
|
|
63
|
+
delegated to a pluggable backend (`pip install sysml2kit[parse]` installs
|
|
64
|
+
[sysmlpy](https://github.com/mycr0ft/sysmlpy)); the kit itself does not
|
|
65
|
+
reimplement the grammar.
|
|
66
|
+
- **JSON interchange**: read/write the Systems Modeling API serialization,
|
|
67
|
+
the format the standard REST API speaks.
|
|
68
|
+
- **Traceability queries**: unsatisfied/unverified requirements, allocation
|
|
69
|
+
tables, requirement-to-part trace matrices.
|
|
70
|
+
- **Validation and diff**: rule-based model checks and element-level diffs.
|
|
71
|
+
- **API client**: a thin HTTP client for the OMG Systems Modeling API and
|
|
72
|
+
Services endpoints.
|
|
73
|
+
|
|
74
|
+
## Install
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
pip install sysml2kit # core: build, write, query, validate, diff
|
|
78
|
+
pip install "sysml2kit[parse]" # + read .sysml files (sysmlpy backend)
|
|
79
|
+
pip install "sysml2kit[graph]" # + NetworkX export
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
## Quick start
|
|
83
|
+
|
|
84
|
+
```python
|
|
85
|
+
from sysml2kit import Model, builder
|
|
86
|
+
|
|
87
|
+
model = Model()
|
|
88
|
+
pkg = builder.pkg(model, "Vehicle")
|
|
89
|
+
battery = builder.part(model, "battery", owner=pkg)
|
|
90
|
+
range_req = builder.req(
|
|
91
|
+
model,
|
|
92
|
+
"REQ-001",
|
|
93
|
+
"Range",
|
|
94
|
+
owner=pkg,
|
|
95
|
+
text="The vehicle shall travel at least 400 km on one charge.",
|
|
96
|
+
)
|
|
97
|
+
builder.satisfy(model, source=battery, target=range_req)
|
|
98
|
+
|
|
99
|
+
from sysml2kit.text import write_model
|
|
100
|
+
|
|
101
|
+
print(write_model(model)) # standard SysML v2 textual notation
|
|
102
|
+
|
|
103
|
+
from sysml2kit.query import unverified_requirements
|
|
104
|
+
|
|
105
|
+
print(unverified_requirements(model)) # [REQ-001] — no verify link yet
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Architecture
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
sysml2kit
|
|
112
|
+
├── model # element classes, Model container, builder API
|
|
113
|
+
├── text # SysML v2 textual notation writer
|
|
114
|
+
├── interchange # Systems Modeling API JSON reader/writer
|
|
115
|
+
├── query # traceability queries
|
|
116
|
+
├── validation # rule-based checks (S2K001...)
|
|
117
|
+
├── diff # element-level model diff
|
|
118
|
+
├── api # Systems Modeling API HTTP client
|
|
119
|
+
├── backends # parser backends (sysmlpy behind the [parse] extra)
|
|
120
|
+
├── interop # tool-agnostic requirement extraction
|
|
121
|
+
└── cli # `sysml2kit` command line
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
The spec pin, element subset, and known deviations are documented in
|
|
125
|
+
[SPEC.md](SPEC.md). Reference spec release: OMG `SysML-v2-Release` tag
|
|
126
|
+
`2026-05`.
|
|
127
|
+
|
|
128
|
+
Domain content lives outside the kit. For antenna/RF systems engineering, see
|
|
129
|
+
[sysml2kit-rf-library](https://github.com/jman4162/sysml2kit-rf-library), a
|
|
130
|
+
SysML v2 model library consumed through this package.
|
|
131
|
+
|
|
132
|
+
## For agents
|
|
133
|
+
|
|
134
|
+
The CLI (`sysml2kit show | validate | diff | export`) is the current
|
|
135
|
+
automation surface. An MCP server is planned for v0.2 under
|
|
136
|
+
`sysml2kit.mcp`.
|
|
137
|
+
|
|
138
|
+
## Development
|
|
139
|
+
|
|
140
|
+
```bash
|
|
141
|
+
uv sync --all-extras --group dev
|
|
142
|
+
uv run pytest # core suite (no extras needed)
|
|
143
|
+
uv run pytest -m parse # round-trip tests against sysmlpy
|
|
144
|
+
uv run ruff check . && uv run ruff format --check .
|
|
145
|
+
uv run mypy
|
|
146
|
+
scripts/slopcheck.sh # prose lint, advisory
|
|
147
|
+
uv run mkdocs serve # docs preview
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Citation
|
|
151
|
+
|
|
152
|
+
```bibtex
|
|
153
|
+
@software{hodge2026sysml2kit,
|
|
154
|
+
author = {Hodge, John},
|
|
155
|
+
title = {sysml2kit: API-first Python tooling for SysML v2 models},
|
|
156
|
+
year = {2026},
|
|
157
|
+
url = {https://github.com/jman4162/sysml2kit},
|
|
158
|
+
license = {Apache-2.0}
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
## License
|
|
163
|
+
|
|
164
|
+
Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). This project contains
|
|
165
|
+
no code or model text from the EPL-2.0 OMG pilot implementation; conformance
|
|
166
|
+
checks run it out of process only.
|