midas-nx 0.1.0__tar.gz

midas_nx-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: pip install -e ".[dev]"
+      - run: pytest
+      - run: pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

midas_nx-0.1.0/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.pyc
+*.pyo
+.venv/
+venv/
+build/
+dist/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.env
+.vscode/
+.idea/

midas_nx-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dennis5882
+
+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.

midas_nx-0.1.0/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: midas-nx
+Version: 0.1.0
+Summary: Independent, unified Python SDK for the MIDAS NX Open API (Civil NX + Gen NX)
+Project-URL: Homepage, https://github.com/Dennis5882/MIDAS-API-NX-SDK
+Project-URL: Manual, https://github.com/Dennis5882/MIDAS-API
+Author: Dennis5882
+License-Expression: MIT
+License-File: LICENSE
+Keywords: civil-nx,gen-nx,midas,midas-nx,structural-engineering
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: responses>=0.23; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# midas-nx
+
+An independent, unified Python SDK for the **MIDAS NX Open API** (MIDAS Civil NX + MIDAS Gen NX).
+
+Unlike MIDASIT's official [`midas-civil`](https://pypi.org/project/midas-civil/) /
+[`midas-gen`](https://github.com/MIDASIT-Co-Ltd/midas-gen-python) packages — separate,
+near-duplicated codebases per product, covering roughly a third of the documented API surface —
+`midas_nx` is a single package for both products, built directly against the endpoint schema
+documented at [Dennis5882/MIDAS-API](https://github.com/Dennis5882/MIDAS-API). See
+[ROADMAP.md](./ROADMAP.md) for what's implemented so far vs. planned.
+
+This is an unofficial, community project — not affiliated with or endorsed by MIDASIT.
+
+## Install
+
+```bash
+pip install -e ".[dev]"   # from a checkout, for development
+```
+
+## Quick start
+
+```python
+from midas_nx import MidasClient, Product
+from midas_nx import doc
+from midas_nx.db.project import Unit
+from midas_nx.db.properties.material import Material
+from midas_nx.db.properties.section import Section
+from midas_nx.db.node_element import Node, Element
+
+client = MidasClient(mapi_key="your-mapi-key-here", product=Product.GEN)
+
+doc.new_project(client=client)
+
+Unit.update({1: {"DIST": "M", "FORCE": "TONF"}}, client=client)
+
+Material.create({1: {
+    "TYPE": "CONC", "NAME": "C32",
+    "PARAM": [{"P_TYPE": 1, "STANDARD": "AS17(RC)", "DB": "C32"}],
+}}, client=client)
+
+Section.create({1: {
+    "SECTTYPE": "DBUSER", "SECT_NAME": "H300x150",
+    "SECT_BEFORE": {
+        "SHAPE": "H", "OFFSET_PT": "CC", "DATATYPE": 1,
+        "SECT_I": {"DB_NAME": "KS21", "SECT_NAME": "H300x150x6.5/9"},
+    },
+}}, client=client)
+
+Node.create({
+    1: {"X": 0, "Y": 0, "Z": 0},
+    2: {"X": 0, "Y": 0, "Z": 3.2},
+}, client=client)
+
+Element.create({1: {
+    "TYPE": "BEAM", "MATL": 1, "SECT": 1, "NODE": [1, 2], "ANGLE": 0,
+}}, client=client)
+
+doc.save(client=client)
+```
+
+Or use the low-level free function directly (same calling convention as the
+[MIDAS-API manual repo](https://github.com/Dennis5882/MIDAS-API)'s examples):
+
+```python
+from midas_nx import configure, MidasAPI
+
+configure(mapi_key="your-mapi-key-here", product="gen")
+MidasAPI("POST", "/doc/NEW", {"Argument": {}})
+```
+
+## Design
+
+- **Instance-based `MidasClient`** — no global mutable state; errors raise typed exceptions
+  (`MidasAuthError`, `MidasNotFoundError`, ...) instead of killing the process.
+- **Unified Gen/Civil** — `MidasClient(product=Product.GEN | Product.CIVIL)`; each resource class
+  declares which product(s) it supports (`PRODUCTS`), and calling a Civil-only resource against a
+  Gen client raises `ProductMismatchError` by default (`strict_product=False` to only warn).
+- **`/db/*` resources** are `DbResource` subclasses with `.create()/.get()/.update()/.delete()`
+  classmethods; `TypedDict` payload types document each endpoint's schema (from
+  `docs/manual/*.md` in the sibling repo) for editor/type-checker support, without runtime
+  payload validation — schemas are too conditional (see e.g. the Eurocode moving-load endpoint,
+  5 mutually-exclusive variants) for a one-size-fits-all validated model.
+- **`/doc/*` lifecycle** endpoints are plain functions (`doc.new_project()`, `doc.save()`, ...) —
+  not ID-keyed, wrapped in `"Argument"` rather than `"Assign"`.
+
+See `docs/coverage.json` / [ROADMAP.md](./ROADMAP.md) for the full endpoint list, what's
+implemented, and where new endpoints should go.
+
+## Testing
+
+No live MIDAS Gen/Civil NX server is required — all tests mock HTTP via
+[`responses`](https://github.com/getsentry/responses) and assert request shape (URL, headers,
+JSON body) against what the manual documents.
+
+```bash
+pytest
+```
+
+## Contributing
+
+Pick an unimplemented endpoint from [ROADMAP.md](./ROADMAP.md), follow the pattern in
+`src/midas_nx/db/node_element.py` (or `doc.py` for `/doc/*`/`/ope/*`/`/view/*`-style plain-function
+endpoints), and add a test mirroring `tests/db/test_node_element.py`. Mark it `"implemented"` in
+`docs/coverage.json` (see `scripts/gen_roadmap.py`) and regenerate `ROADMAP.md`.
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

midas_nx-0.1.0/README.md

@@ -0,0 +1,108 @@
+# midas-nx
+
+An independent, unified Python SDK for the **MIDAS NX Open API** (MIDAS Civil NX + MIDAS Gen NX).
+
+Unlike MIDASIT's official [`midas-civil`](https://pypi.org/project/midas-civil/) /
+[`midas-gen`](https://github.com/MIDASIT-Co-Ltd/midas-gen-python) packages — separate,
+near-duplicated codebases per product, covering roughly a third of the documented API surface —
+`midas_nx` is a single package for both products, built directly against the endpoint schema
+documented at [Dennis5882/MIDAS-API](https://github.com/Dennis5882/MIDAS-API). See
+[ROADMAP.md](./ROADMAP.md) for what's implemented so far vs. planned.
+
+This is an unofficial, community project — not affiliated with or endorsed by MIDASIT.
+
+## Install
+
+```bash
+pip install -e ".[dev]"   # from a checkout, for development
+```
+
+## Quick start
+
+```python
+from midas_nx import MidasClient, Product
+from midas_nx import doc
+from midas_nx.db.project import Unit
+from midas_nx.db.properties.material import Material
+from midas_nx.db.properties.section import Section
+from midas_nx.db.node_element import Node, Element
+
+client = MidasClient(mapi_key="your-mapi-key-here", product=Product.GEN)
+
+doc.new_project(client=client)
+
+Unit.update({1: {"DIST": "M", "FORCE": "TONF"}}, client=client)
+
+Material.create({1: {
+    "TYPE": "CONC", "NAME": "C32",
+    "PARAM": [{"P_TYPE": 1, "STANDARD": "AS17(RC)", "DB": "C32"}],
+}}, client=client)
+
+Section.create({1: {
+    "SECTTYPE": "DBUSER", "SECT_NAME": "H300x150",
+    "SECT_BEFORE": {
+        "SHAPE": "H", "OFFSET_PT": "CC", "DATATYPE": 1,
+        "SECT_I": {"DB_NAME": "KS21", "SECT_NAME": "H300x150x6.5/9"},
+    },
+}}, client=client)
+
+Node.create({
+    1: {"X": 0, "Y": 0, "Z": 0},
+    2: {"X": 0, "Y": 0, "Z": 3.2},
+}, client=client)
+
+Element.create({1: {
+    "TYPE": "BEAM", "MATL": 1, "SECT": 1, "NODE": [1, 2], "ANGLE": 0,
+}}, client=client)
+
+doc.save(client=client)
+```
+
+Or use the low-level free function directly (same calling convention as the
+[MIDAS-API manual repo](https://github.com/Dennis5882/MIDAS-API)'s examples):
+
+```python
+from midas_nx import configure, MidasAPI
+
+configure(mapi_key="your-mapi-key-here", product="gen")
+MidasAPI("POST", "/doc/NEW", {"Argument": {}})
+```
+
+## Design
+
+- **Instance-based `MidasClient`** — no global mutable state; errors raise typed exceptions
+  (`MidasAuthError`, `MidasNotFoundError`, ...) instead of killing the process.
+- **Unified Gen/Civil** — `MidasClient(product=Product.GEN | Product.CIVIL)`; each resource class
+  declares which product(s) it supports (`PRODUCTS`), and calling a Civil-only resource against a
+  Gen client raises `ProductMismatchError` by default (`strict_product=False` to only warn).
+- **`/db/*` resources** are `DbResource` subclasses with `.create()/.get()/.update()/.delete()`
+  classmethods; `TypedDict` payload types document each endpoint's schema (from
+  `docs/manual/*.md` in the sibling repo) for editor/type-checker support, without runtime
+  payload validation — schemas are too conditional (see e.g. the Eurocode moving-load endpoint,
+  5 mutually-exclusive variants) for a one-size-fits-all validated model.
+- **`/doc/*` lifecycle** endpoints are plain functions (`doc.new_project()`, `doc.save()`, ...) —
+  not ID-keyed, wrapped in `"Argument"` rather than `"Assign"`.
+
+See `docs/coverage.json` / [ROADMAP.md](./ROADMAP.md) for the full endpoint list, what's
+implemented, and where new endpoints should go.
+
+## Testing
+
+No live MIDAS Gen/Civil NX server is required — all tests mock HTTP via
+[`responses`](https://github.com/getsentry/responses) and assert request shape (URL, headers,
+JSON body) against what the manual documents.
+
+```bash
+pytest
+```
+
+## Contributing
+
+Pick an unimplemented endpoint from [ROADMAP.md](./ROADMAP.md), follow the pattern in
+`src/midas_nx/db/node_element.py` (or `doc.py` for `/doc/*`/`/ope/*`/`/view/*`-style plain-function
+endpoints), and add a test mirroring `tests/db/test_node_element.py`. Mark it `"implemented"` in
+`docs/coverage.json` (see `scripts/gen_roadmap.py`) and regenerate `ROADMAP.md`.
+
+## License
+
+MIT — see [LICENSE](./LICENSE).