sysatlas 0.2.0__tar.gz

sysatlas-0.2.0/.claude/CLAUDE.md

@@ -0,0 +1,81 @@
+# sysatlas
+
+Interactive system and architecture diagram library.
+Python describes the diagram; draw.io viewer renders interactive HTML.
+
+Core flow: `SystemMap → mxGraph XML → draw.io viewer → .html`
+
+## Read this first, every new session
+
+After loading this file, immediately read [`../docs/README.md`](../docs/README.md).
+That file is the canonical index of the whole project: public API,
+ontologies, features-to-source-and-doc map, source tree, docs tree,
+and the roadmap. Anything you need to find in this codebase is one
+hop from there.
+
+## API surface
+
+`SystemMap` is the only public class. Keep it that way.
+Do not add a CLI entry point — this is a library.
+
+## Output files
+
+Generated `.html` files are in `.gitignore`. They are not committed.
+The `.py` diagram scripts are the versioned source.
+
+## Project venv
+
+`.venv/` at repo root. No external dependencies (draw.io viewer bundled).
+
+## Design principles
+
+Before designing or changing layout, routing, ontology, or API behaviour,
+read [`docs/design-principles.md`](../docs/design-principles.md). Two
+non-negotiables:
+
+- **Bounded complexity per view** — sysatlas targets low-complexity
+  diagrams (rough budget: 5–10 components, 8–15 connections per view).
+  Algorithms are tuned for this regime; degrading at higher counts is
+  intentional.
+- **Multi-view by default** — a system is described by several focused
+  views, not one giant diagram. When a view gets dense, the right answer
+  is to split it (by bounded context, layer, stakeholder concern, feature,
+  or zoom level), not to fight the layout engine.
+
+For the wider academic / industry context (ISO 42010, C4, ArchiMate,
+UML / SysML / BPMN, layout algorithms, export formats, quality models,
+domain modelling), see [`docs/state-of-the-art.md`](../docs/state-of-the-art.md).
+
+## Diagram ontologies
+
+Each supported diagram type has a typed ontology under
+`sysatlas/_ontology/` and a prose spec under `docs/ontology/`.
+
+**Before working on anything diagram-specific** (adding a feature to a
+diagram type, debugging routing/placement for a particular diagram,
+extending the builder API, writing tests), read the corresponding files:
+
+| Diagram type | Schema | Doc |
+|---|---|---|
+| Layered architecture | `sysatlas/_ontology/architecture.py` | `docs/ontology/architecture.md` |
+| Entity-Relationship | `sysatlas/_ontology/er.py` | `docs/ontology/er.md` |
+| Sequence | `sysatlas/_ontology/sequence.py` | `docs/ontology/sequence.md` |
+| Class (UML) | `sysatlas/_ontology/uml_class.py` | `docs/ontology/uml_class.md` |
+| State machine | `sysatlas/_ontology/state_machine.py` | `docs/ontology/state_machine.md` |
+| BPMN process | `sysatlas/_ontology/bpmn.py` | `docs/ontology/bpmn.md` |
+| Tree (org / mindmap / etc.) | `sysatlas/_ontology/tree.py` | `docs/ontology/tree.md` |
+
+Cross-cutting ontologies (apply to multiple diagram types, not a diagram
+type themselves):
+
+| Concern | Schema | Doc |
+|---|---|---|
+| ISO 42010 meta (Stakeholder/Concern/Viewpoint/View/AD) | `sysatlas/_ontology/iso42010.py` | `docs/ontology/iso42010.md` |
+| Trace links across model kinds | `sysatlas/_ontology/trace.py` | `docs/ontology/trace.md` |
+| Quality attributes (ISO 25010) | `sysatlas/_ontology/qualities.py` | `docs/ontology/qualities.md` |
+
+Always read **both** the schema (Pydantic models, source of truth) and
+the doc (semantics, validation rules, distinctions from neighbouring
+types) before changing anything in that diagram's pipeline. The index
+of all ontologies plus what was intentionally omitted lives at
+`docs/ontology/README.md`. The short-term roadmap is `docs/todo.md`.

sysatlas-0.2.0/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: CServinL

sysatlas-0.2.0/.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: pip install hatchling
+      - run: python -m hatchling build
+      - uses: pypa/gh-action-pypi-publish@release/v1

sysatlas-0.2.0/.gitignore

@@ -0,0 +1,21 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.venv/
+.eggs/
+*.egg
+.pytest_cache/
+.coverage
+htmlcov/
+
+# generated diagram output (the .py builder script is the source of truth).
+# Exception: docs/demos/html/ holds committed CDN-mode renders of each demo.
+*.html
+!docs/demos/html/*.html
+!docs/reflection/*.html
+
+# local dev helpers, not part of the library
+_scratch_*.py

sysatlas-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sysatlas-0.2.0/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.4
+Name: sysatlas
+Version: 0.2.0
+Summary: Interactive system and architecture diagram library
+Project-URL: Homepage, https://github.com/CServinL/sysatlas
+Project-URL: Repository, https://github.com/CServinL/sysatlas
+Project-URL: Issues, https://github.com/CServinL/sysatlas/issues
+Project-URL: Funding, https://github.com/sponsors/CServinL
+License: Apache-2.0
+License-File: LICENSE
+Keywords: architecture,diagram,drawio,topology,visualization
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Classifier: Topic :: Software Development :: Documentation
+Requires-Python: >=3.10
+Requires-Dist: networkx>=3.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: reflect-rust
+Requires-Dist: tree-sitter-rust>=0.24; extra == 'reflect-rust'
+Requires-Dist: tree-sitter>=0.24; extra == 'reflect-rust'
+Description-Content-Type: text/markdown
+
+# sysatlas
+
+[![Sponsor](https://img.shields.io/badge/Sponsor-CServinL-ea4aaa?logo=github)](https://github.com/sponsors/CServinL)
+
+**For software architects who keep redrawing the same diagram because it
+got unreadable — and for the AI coding assistants that keep the
+diagrams in sync with the code.**
+
+![sysatlas — read/write loops around the ontology](docs/reflection/img/loops.png)
+
+Most diagram tools let you cram everything onto one canvas, then leave
+you fighting the layout engine. sysatlas does the opposite: focused
+views (~10 components each), and **splitting one system into many
+small diagrams** is a first-class operation.
+
+It works in both directions:
+
+### Forward — design before code
+
+You describe a system in Python and:
+
+- **Split** it into focused views — *storefront*, *payments*,
+  *async backbone* — each one fits on a slide.
+- **Cross-reference** between views with auto-detected stub nodes, so a
+  component defined in one view shows up as a ghost reference in others.
+- **Annotate** components with ISO 25010 quality attributes
+  (`security: critical`, `performance: high`) — rendered as coloured
+  badges.
+- **Trace** how things relate across views (`Cart depends_on Payments`,
+  `APIController realizes API`) using SysML link vocabulary.
+- **Ground** the whole thing in ISO 42010 (Stakeholders / Concerns /
+  Viewpoints / Views) so the *why* is captured alongside the *what*.
+
+### Backward — reflect after the code lands
+
+You point sysatlas at an existing source tree and it reads the real
+structure:
+
+```python
+import sysatlas
+
+# Python project
+r = sysatlas.reflect("src/")
+m = r.to_system_map(title="src internals")
+m.save("docs/reflection/module-map.html")
+
+# Rust crate  (pip install 'sysatlas[reflect-rust]')
+r = sysatlas.reflect_rust("my-crate/")
+m = r.to_system_map(title="my-crate internals")
+m.save("docs/reflection/module-map.html")
+```
+
+Static analysis — no execution, safe on broken or uncompiled code. The
+output is the same `SystemMap` the forward flow produces, so a thin
+human-authored "annotation overlay" (qualities, traces, viewpoints)
+can be merged onto reflected structure via `r.merge_with(overlay)`.
+Drift between intent and reality becomes visible instead of silent.
+
+### The intended loop
+
+1. **Plan** the change with a forward-flow diagram on a feature branch.
+2. **Implement** the feature.
+3. **Reflect** the branch (`sysatlas.reflect(...)`) and commit the
+   regenerated diagrams alongside the code. Reviewers see structure
+   and intent change together.
+
+Output is a single self-contained HTML file — no server, no extra
+runtime dependencies, opens in any browser.
+
+```bash
+pip install sysatlas                        # Python reflection included
+pip install 'sysatlas[reflect-rust]'        # + Rust crate reflection
+```
+
+## Using sysatlas with an AI coding assistant
+
+sysatlas ships a guide aimed at LLMs. Tell your coding assistant
+(Claude Code, Cursor, Aider, …) to read it before working on this
+repo. The one-liner to paste into your `CLAUDE.md` / `.cursorrules` /
+`AGENTS.md`:
+
+> Before editing this project, read sysatlas's LLM guide:
+> `python -c "import sysatlas; print(sysatlas.llm_guide())"`.
+> After any structural change (add/remove/rename modules or
+> components), regenerate the affected diagrams under
+> `docs/reflection/` using `sysatlas.reflect(...)` and commit them
+> with the code change.
+
+The guide tells the assistant exactly which symbols are public, which
+fields the ontology accepts, and that diagrams are part of the
+deliverable — not an afterthought.
+
+## Where to look
+
+- Runnable feature-by-feature showcases live in
+  [`docs/demos/`](docs/demos/) — start with
+  [`docs/demos/architecture.py`](docs/demos/architecture.py).
+- Design philosophy: [`docs/design-principles.md`](docs/design-principles.md).
+- Full app index: [`docs/README.md`](docs/README.md).
+- How sysatlas relates to C4 / ArchiMate / UML / BPMN / ISO 42010:
+  [`docs/state-of-the-art.md`](docs/state-of-the-art.md).
+
+Apache 2.0 licensed.

sysatlas-0.2.0/README.md

@@ -0,0 +1,103 @@
+# sysatlas
+
+[![Sponsor](https://img.shields.io/badge/Sponsor-CServinL-ea4aaa?logo=github)](https://github.com/sponsors/CServinL)
+
+**For software architects who keep redrawing the same diagram because it
+got unreadable — and for the AI coding assistants that keep the
+diagrams in sync with the code.**
+
+![sysatlas — read/write loops around the ontology](docs/reflection/img/loops.png)
+
+Most diagram tools let you cram everything onto one canvas, then leave
+you fighting the layout engine. sysatlas does the opposite: focused
+views (~10 components each), and **splitting one system into many
+small diagrams** is a first-class operation.
+
+It works in both directions:
+
+### Forward — design before code
+
+You describe a system in Python and:
+
+- **Split** it into focused views — *storefront*, *payments*,
+  *async backbone* — each one fits on a slide.
+- **Cross-reference** between views with auto-detected stub nodes, so a
+  component defined in one view shows up as a ghost reference in others.
+- **Annotate** components with ISO 25010 quality attributes
+  (`security: critical`, `performance: high`) — rendered as coloured
+  badges.
+- **Trace** how things relate across views (`Cart depends_on Payments`,
+  `APIController realizes API`) using SysML link vocabulary.
+- **Ground** the whole thing in ISO 42010 (Stakeholders / Concerns /
+  Viewpoints / Views) so the *why* is captured alongside the *what*.
+
+### Backward — reflect after the code lands
+
+You point sysatlas at an existing source tree and it reads the real
+structure:
+
+```python
+import sysatlas
+
+# Python project
+r = sysatlas.reflect("src/")
+m = r.to_system_map(title="src internals")
+m.save("docs/reflection/module-map.html")
+
+# Rust crate  (pip install 'sysatlas[reflect-rust]')
+r = sysatlas.reflect_rust("my-crate/")
+m = r.to_system_map(title="my-crate internals")
+m.save("docs/reflection/module-map.html")
+```
+
+Static analysis — no execution, safe on broken or uncompiled code. The
+output is the same `SystemMap` the forward flow produces, so a thin
+human-authored "annotation overlay" (qualities, traces, viewpoints)
+can be merged onto reflected structure via `r.merge_with(overlay)`.
+Drift between intent and reality becomes visible instead of silent.
+
+### The intended loop
+
+1. **Plan** the change with a forward-flow diagram on a feature branch.
+2. **Implement** the feature.
+3. **Reflect** the branch (`sysatlas.reflect(...)`) and commit the
+   regenerated diagrams alongside the code. Reviewers see structure
+   and intent change together.
+
+Output is a single self-contained HTML file — no server, no extra
+runtime dependencies, opens in any browser.
+
+```bash
+pip install sysatlas                        # Python reflection included
+pip install 'sysatlas[reflect-rust]'        # + Rust crate reflection
+```
+
+## Using sysatlas with an AI coding assistant
+
+sysatlas ships a guide aimed at LLMs. Tell your coding assistant
+(Claude Code, Cursor, Aider, …) to read it before working on this
+repo. The one-liner to paste into your `CLAUDE.md` / `.cursorrules` /
+`AGENTS.md`:
+
+> Before editing this project, read sysatlas's LLM guide:
+> `python -c "import sysatlas; print(sysatlas.llm_guide())"`.
+> After any structural change (add/remove/rename modules or
+> components), regenerate the affected diagrams under
+> `docs/reflection/` using `sysatlas.reflect(...)` and commit them
+> with the code change.
+
+The guide tells the assistant exactly which symbols are public, which
+fields the ontology accepts, and that diagrams are part of the
+deliverable — not an afterthought.
+
+## Where to look
+
+- Runnable feature-by-feature showcases live in
+  [`docs/demos/`](docs/demos/) — start with
+  [`docs/demos/architecture.py`](docs/demos/architecture.py).
+- Design philosophy: [`docs/design-principles.md`](docs/design-principles.md).
+- Full app index: [`docs/README.md`](docs/README.md).
+- How sysatlas relates to C4 / ArchiMate / UML / BPMN / ISO 42010:
+  [`docs/state-of-the-art.md`](docs/state-of-the-art.md).
+
+Apache 2.0 licensed.