gomc-rest 0.1.0__tar.gz

gomc_rest-0.1.0/.claude/CLAUDE.md

@@ -0,0 +1,78 @@
+# CLAUDE.md
+
+Behavioral guidelines to reduce common LLM coding mistakes. Merge with project-specific instructions as needed.
+
+**Tradeoff:** These guidelines bias toward caution over speed. For trivial tasks, use judgment.
+
+## 1. Think Before Coding
+
+**Don't assume. Don't hide confusion. Surface tradeoffs.**
+
+Before implementing:
+- State your assumptions explicitly. If uncertain, ask.
+- If multiple interpretations exist, present them - don't pick silently.
+- If a simpler approach exists, say so. Push back when warranted.
+- If something is unclear, stop. Name what's confusing. Ask.
+
+## 2. Simplicity First
+
+**Minimum code that solves the problem. Nothing speculative.**
+
+- No features beyond what was asked.
+- No abstractions for single-use code.
+- No "flexibility" or "configurability" that wasn't requested.
+- No error handling for impossible scenarios.
+- If you write 200 lines and it could be 50, rewrite it.
+
+Ask yourself: "Would a senior engineer say this is overcomplicated?" If yes, simplify.
+
+## 3. Surgical Changes
+
+**Touch only what you must. Clean up only your own mess.**
+
+When editing existing code:
+- Don't "improve" adjacent code, comments, or formatting.
+- Don't refactor things that aren't broken.
+- Match existing style, even if you'd do it differently.
+- If you notice unrelated dead code, mention it - don't delete it.
+
+When your changes create orphans:
+- Remove imports/variables/functions that YOUR changes made unused.
+- Don't remove pre-existing dead code unless asked.
+
+The test: Every changed line should trace directly to the user's request.
+
+## 4. Goal-Driven Execution
+
+**Define success criteria. Loop until verified.**
+
+Transform tasks into verifiable goals:
+- "Add validation" → "Write tests for invalid inputs, then make them pass"
+- "Fix the bug" → "Write a test that reproduces it, then make it pass"
+- "Refactor X" → "Ensure tests pass before and after"
+
+For multi-step tasks, state a brief plan:
+```
+1. [Step] → verify: [check]
+2. [Step] → verify: [check]
+3. [Step] → verify: [check]
+```
+
+Strong success criteria let you loop independently. Weak criteria ("make it work") require constant clarification.
+
+---
+
+**These guidelines are working if:** fewer unnecessary changes in diffs, fewer rewrites due to overcomplication, and clarifying questions come before implementation rather than after mistakes.
+
+
+---
+**Stream Timeout Prevention**
+ - Do each task ONE AT A TIME. Complete one, confirm, then move to the next.
+ - Never write a file longer than ~150 lines in a single tool call.
+ - If a file will be longer, write it in multiple append/edit passes.
+ - Start a fresh session if the conversation gets long (20+ tool calls).
+ - The error gets worse as the session grows.
+ - Keep individual grep/search outputs short. Use flags like
+ - --include and -l (list files only) to limit output size.
+ - If you do hit the timeout, retry the same step in a shorter form.
+ - Don't repeat the entire task from scratch.

gomc_rest-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,41 @@
+name: ci
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install package and test deps
+        run: python -m pip install -e . pytest
+
+      - name: Vendor the Linux server binary
+        run: python scripts/vendor_binaries.py --only gomc-rest-linux-amd64
+
+      - name: Run tests
+        run: python -m pytest -v
+
+  # Verify the dynamically-linked amd64 binary actually starts on its declared
+  # glibc floor (manylinux_2_34 == glibc 2.34), not just on the latest runner.
+  floor-glibc-amd64:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Smoke test on glibc 2.34
+        run: |
+          docker run --rm -v "$PWD":/w -w /w \
+            quay.io/pypa/manylinux_2_34_x86_64 bash -c '
+              PY=/opt/python/cp311-cp311/bin/python
+              "$PY" -m pip install -e . pytest &&
+              "$PY" scripts/vendor_binaries.py --only gomc-rest-linux-amd64 &&
+              "$PY" -m pytest -v
+            '

gomc_rest-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,114 @@
+name: release
+
+# Build one platform-specific wheel per OS (each bundling only its matching
+# gomc-rest binary) plus a binary-free sdist, and publish to PyPI on a version
+# tag. The sdist is the client-only fallback: on platforms without a matching
+# wheel (macOS, Windows arm64, glibc < 2.34), pip builds it so connect() still
+# works (launch() then raises a clear "binary not found/unsupported" error).
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+jobs:
+  build-wheels:
+    name: wheel (${{ matrix.plat }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            asset: gomc-rest.exe
+            plat: win_amd64
+          # amd64 binary is dynamically linked and needs GLIBC_2.34, so it must
+          # be tagged manylinux_2_34 (not 2014/glibc 2.17) or pip would install
+          # it on older systems where it fails with "GLIBC_2.34 not found".
+          - os: ubuntu-latest
+            asset: gomc-rest-linux-amd64
+            plat: manylinux_2_34_x86_64
+          # arm64 binary is statically linked (no glibc dependency), so the
+          # widest valid tag is fine.
+          - os: ubuntu-24.04-arm
+            asset: gomc-rest-linux-arm64
+            plat: manylinux2014_aarch64
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Check tag matches project version
+        if: github.ref_type == 'tag'
+        shell: bash
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          proj=$(python -c "import tomllib,pathlib; print(tomllib.loads(pathlib.Path('pyproject.toml').read_bytes().decode())['project']['version'])")
+          echo "tag=$tag project.version=$proj"
+          test "$tag" = "$proj" || { echo "::error::tag $GITHUB_REF_NAME does not match project.version $proj"; exit 1; }
+
+      - name: Install build tooling
+        run: python -m pip install --upgrade build wheel
+
+      - name: Vendor the matching server binary
+        run: python scripts/vendor_binaries.py --only ${{ matrix.asset }}
+
+      - name: Build wheel
+        run: python -m build --wheel
+
+      - name: Re-tag wheel for this platform
+        shell: bash
+        run: python -m wheel tags --platform-tag ${{ matrix.plat }} --remove dist/*.whl
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheel-${{ matrix.plat }}
+          path: dist/*.whl
+
+  build-sdist:
+    name: sdist (client-only fallback)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Check tag matches project version
+        if: github.ref_type == 'tag'
+        shell: bash
+        run: |
+          tag="${GITHUB_REF_NAME#v}"
+          proj=$(python -c "import tomllib,pathlib; print(tomllib.loads(pathlib.Path('pyproject.toml').read_bytes().decode())['project']['version'])")
+          test "$tag" = "$proj" || { echo "::error::tag $GITHUB_REF_NAME does not match project.version $proj"; exit 1; }
+
+      - name: Build sdist (no binary bundled)
+        run: |
+          python -m pip install --upgrade build
+          python -m build --sdist
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+
+  publish:
+    name: publish to PyPI
+    needs: [build-wheels, build-sdist]
+    # Only publish for real version tags; workflow_dispatch builds wheels for
+    # verification but must never publish from an arbitrary branch.
+    if: github.ref_type == 'tag'
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # trusted publishing (OIDC) — no API token needed
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - uses: pypa/gh-action-pypi-publish@release/v1

gomc_rest-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

gomc_rest-0.1.0/GOMC_REST_VERSION

@@ -0,0 +1 @@
+v1.4.0

gomc_rest-0.1.0/LICENSE

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

gomc_rest-0.1.0/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.4
+Name: gomc-rest
+Version: 0.1.0
+Summary: Talk to Mitsubishi PLCs from Python over the MC protocol via a bundled, auto-launched gomc-rest server — with optional REST API exposure.
+Project-URL: Homepage, https://github.com/Moge800/gomc_rest_python
+Project-URL: Upstream server, https://github.com/Moge800/gomc-rest
+Project-URL: HTTP client, https://github.com/Moge800/gomc_rest_client
+Author: Moge800
+License: MIT
+License-File: LICENSE
+Keywords: gomc-rest,mc-protocol,mitsubishi,plc,slmp
+Requires-Python: >=3.10
+Requires-Dist: gomc-rest-client<0.11,>=0.10.0
+Description-Content-Type: text/markdown
+
+# gomc-rest (Python)
+
+English / [日本語](https://github.com/Moge800/gomc_rest_python/blob/main/README_JP.md)
+
+**A Python library for talking to Mitsubishi PLCs.** Read and write PLC devices
+over the MC protocol (3E/4E frames) — the protocol is handled for you by a bundled
+[gomc-rest](https://github.com/Moge800/gomc-rest) server that the package
+auto-launches, so you never have to start or distribute an executable yourself.
+
+**Bonus — expose a REST API.** Enable `server_mode` to make the bundled
+server's REST API reachable from other apps on your network (a GUI, another
+machine, another language); and `connect()` talks to a gomc-rest server that is
+already running elsewhere. See [Access control](#access-control).
+
+Under the hood the HTTP layer is provided by
+[gomc-rest-client](https://github.com/Moge800/gomc_rest_client); this package
+adds the bundled binary and its process lifecycle.
+
+```text
+your Python process
+└─ gomc_rest.launch()
+     ├─ spawns the bundled gomc-rest on a free loopback port  ── MC protocol ──▶ PLC
+     └─ returns a Server that provides a PLCClient pointed at it
+```
+
+## Install
+
+```bash
+pip install gomc-rest
+```
+
+## Usage
+
+```python
+import gomc_rest
+
+with gomc_rest.launch(plc_host="192.168.0.1") as plc:
+    values = plc.read("D100", 3)
+    plc.write("D100", [10, 20, 30])
+# the bundled server is stopped automatically on exit
+```
+
+`launch()` returns a `Server`; using it as a context manager yields a
+`PLCClient` (see gomc-rest-client for the full read/write/remote API) and stops
+the server on exit. Without `with`, the server is stopped at interpreter exit.
+
+Pass server flags through `extra_args`:
+
+```python
+with gomc_rest.launch(plc_host="192.168.0.1", extra_args=["-enable-remote"]) as plc:
+    plc.remote_run()
+```
+
+### Client mode (connect to an existing server)
+
+To talk to a gomc-rest server that is already running elsewhere — a shared
+instance, another machine, or one you launched with `server_mode=True` — use
+`connect()` instead of starting the bundled binary:
+
+```python
+with gomc_rest.connect("http://192.168.0.1:8080", token="...") as plc:
+    plc.read("D100", 3)
+```
+
+Both `launch()` and `connect()` hand you the same `PLCClient`, so one package
+covers "bundle and run the server" and "just be a client".
+
+`connect()` needs no bundled binary, so it works even on platforms without a
+prebuilt wheel (macOS, Windows arm64, glibc < 2.34): there `pip install
+gomc-rest` installs from the sdist, and only `launch()` is unavailable (it
+raises a clear error).
+
+## Access control
+
+Two independent layers protect the server, both on by default:
+
+1. **Per-launch bearer token.** A random token is generated each launch and
+   required by the server, so even another process on the same host that
+   discovers the port cannot call the API. It is set automatically on the
+   returned client and exposed as `server.token`. Pass an explicit `token=` to
+   share with another app, or `token=""` to disable auth (closed-network use).
+2. **Loopback binding.** By default the server binds to `127.0.0.1`, so no
+   other host can reach it.
+
+Set `server_mode=True` to bind all interfaces so other apps on the network
+(e.g. gomc-rest-gui, curl from another machine) can call it — give them
+`server.token`:
+
+```python
+server = gomc_rest.launch(plc_host="192.168.0.1", server_mode=True)
+print(server.base_url)   # other apps connect to http://<this-host>:<port>
+print(server.token)      # ...with this bearer token
+try:
+    server.client.read("D100", 3)
+finally:
+    server.close()
+```
+
+The server has no TLS — only enable `server_mode` on a trusted network.
+
+**Threat model.** The token is passed to the server via the `GOMCR_TOKEN`
+environment variable (not the command line), so it does not appear in the
+process list. It protects against other hosts and other OS users. It does
+**not** protect against another process running as the **same OS user**, which
+can read the server's environment (e.g. `/proc/<pid>/environ`); the OS user
+boundary is the trust boundary here.
+
+## Versions
+
+This package bundles a pinned `gomc-rest` binary (currently **v1.4.0**, set in
+`GOMC_REST_VERSION`) that must satisfy `gomc-rest-client`'s
+`MINIMUM_SUPPORTED_GOMC_REST_VERSION`; `launch()` verifies this on startup. The
+`gomc-rest-client` dependency is capped (`>=0.10.0,<0.11`) so a future client
+that raises its minimum server version can't be installed without also bumping
+the bundled binary.
+
+## Releasing / bundled binaries
+
+The bundled server version is pinned in `GOMC_REST_VERSION`. Binaries are not
+committed to git; they are fetched from the matching gomc-rest GitHub release.
+
+- Locally: `python scripts/vendor_binaries.py` downloads all three binaries
+  into `src/gomc_rest/binaries/`, verifying each against the trusted SHA-256
+  values committed in `checksums/<version>.sha256`.
+- On a `v*` tag, `.github/workflows/release.yml` builds one platform-specific
+  wheel per OS (each bundling only its matching binary) and publishes to PyPI
+  via trusted publishing. The release job verifies the tag equals
+  `project.version`; `workflow_dispatch` builds wheels for verification only and
+  never publishes.
+
+To cut a release:
+
+1. To change the bundled server, edit `GOMC_REST_VERSION` (keep it within the
+   range accepted by the pinned `gomc-rest-client`) and add a matching
+   `checksums/<version>.sha256` with the trusted SHA-256 of each asset. If the
+   new binaries change their glibc requirement, update the `plat` tags in
+   `release.yml` accordingly.
+2. Bump the package version in **both** `pyproject.toml` (`project.version`)
+   and `src/gomc_rest/__init__.py` (`__version__`) — they must match.
+3. Tag that exact version, e.g. `git tag v0.2.0 && git push origin v0.2.0`
+   (the tag must equal `project.version` or the release job fails).