gomc-rest-client 0.1.0__tar.gz

gomc_rest_client-0.1.0/.gitignore

@@ -0,0 +1,223 @@
+# 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
+
+.claude/
+.github/
+.docs/
+.vscode/

gomc_rest_client-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_client-0.1.0/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: gomc-rest-client
+Version: 0.1.0
+Summary: Synchronous Python client for the gomc-rest API
+Project-URL: Homepage, https://github.com/Moge800/gomc-rest
+Author: Moge800
+License-Expression: MIT
+License-File: LICENSE
+Keywords: gomc-rest,mc-protocol,mitsubishi,plc
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT 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 :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# gomc-rest-client
+
+[日本語版 README](https://github.com/Moge800/gomc_rest_client/blob/main/README_JP.md)
+
+Python 3.10+ client library for the latest gomc-rest HTTP API.
+
+This package wraps the synchronous REST endpoints exposed by gomc-rest for Mitsubishi PLC read, write, and remote-control operations using only the Python standard library, and converts API error responses into typed Python exceptions.
+
+## About gomc-rest-client
+
+This package is a dedicated client library for gomc-rest. It is intended for users who already use gomc-rest, or who want to expose Mitsubishi PLC operations through the gomc-rest HTTP API.
+
+This library does not communicate with PLCs directly. If you need the server, API surface, or gomc-rest itself, see the upstream project:
+
+- https://github.com/Moge800/gomc-rest
+
+## Install
+
+```bash
+uv add gomc-rest-client
+```
+
+With pip:
+
+```bash
+pip install gomc-rest-client
+```
+
+For offline environments, install from a prebuilt wheel distributed inside your network:
+
+```bash
+pip install dist/gomc_rest_client-*.whl
+```
+
+This package has no runtime dependencies outside the Python standard library, so wheel-based offline installation is straightforward.
+
+For local development:
+
+```bash
+uv sync --group dev
+```
+
+To build distributable artifacts before taking them into an offline environment:
+
+```bash
+uv build
+```
+
+## Usage
+
+```python
+from gomc_rest_client import (
+    MINIMUM_SUPPORTED_GOMC_REST_VERSION,
+    BusyError,
+    PLCClient,
+    PLCProtocolError,
+)
+
+with PLCClient("http://192.168.0.1:8080") as plc:
+    health = plc.health()
+    metrics = plc.metrics()
+    version = plc.version()
+    is_supported = plc.is_supported_version()
+    is_compatible = plc.is_version_compatible(MINIMUM_SUPPORTED_GOMC_REST_VERSION)
+    values = plc.read("D100", 3)
+    bits = plc.read("M0", 4)
+    dwords = plc.read("D100", 2, dword=True)
+    signed = plc.read("D100", 3, sint=True)
+
+    plc.write("D100", [10, 20, 30])
+    plc.write("M0", [True, False])
+    plc.write("D100", [-1, -32768, 32767], sint=True)
+
+    try:
+        plc.remote_run(clear=0, force=False)
+    except BusyError:
+        pass
+    except PLCProtocolError as exc:
+        print(exc.end_code, exc.message)
+```
+
+`is_supported_version()` and `is_version_compatible()` treat `dev` builds as compatible by default so local gomc-rest main builds can pass version checks during development.
+
+## Supported gomc-rest versions
+
+This client supports gomc-rest `v0.6.0` and later.
+
+Servers older than `v0.6.0` are not supported. In particular, servers without the `/version` endpoint are out of scope for this client.
+
+This client expects the server to expose both `/version` and `/metrics`.
+
+If you need to verify the support policy at runtime, call `plc.is_supported_version()` or compare against `MINIMUM_SUPPORTED_GOMC_REST_VERSION`.
+
+## API coverage
+
+- GET /version
+- GET /metrics
+- GET /health
+- GET /read
+- POST /write
+- POST /remote/run
+- POST /remote/stop
+- POST /remote/pause
+- POST /remote/latch-clear
+- POST /remote/reset
+
+Remote-control endpoints require the gomc-rest server to start with `-enable-remote`.
+
+## Development
+
+Run checks with uv:
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run ty check
+uv build
+```
+
+To publish to PyPI after configuring credentials:
+
+```bash
+uv publish
+```

gomc_rest_client-0.1.0/README.md

@@ -0,0 +1,124 @@
+# gomc-rest-client
+
+[日本語版 README](https://github.com/Moge800/gomc_rest_client/blob/main/README_JP.md)
+
+Python 3.10+ client library for the latest gomc-rest HTTP API.
+
+This package wraps the synchronous REST endpoints exposed by gomc-rest for Mitsubishi PLC read, write, and remote-control operations using only the Python standard library, and converts API error responses into typed Python exceptions.
+
+## About gomc-rest-client
+
+This package is a dedicated client library for gomc-rest. It is intended for users who already use gomc-rest, or who want to expose Mitsubishi PLC operations through the gomc-rest HTTP API.
+
+This library does not communicate with PLCs directly. If you need the server, API surface, or gomc-rest itself, see the upstream project:
+
+- https://github.com/Moge800/gomc-rest
+
+## Install
+
+```bash
+uv add gomc-rest-client
+```
+
+With pip:
+
+```bash
+pip install gomc-rest-client
+```
+
+For offline environments, install from a prebuilt wheel distributed inside your network:
+
+```bash
+pip install dist/gomc_rest_client-*.whl
+```
+
+This package has no runtime dependencies outside the Python standard library, so wheel-based offline installation is straightforward.
+
+For local development:
+
+```bash
+uv sync --group dev
+```
+
+To build distributable artifacts before taking them into an offline environment:
+
+```bash
+uv build
+```
+
+## Usage
+
+```python
+from gomc_rest_client import (
+    MINIMUM_SUPPORTED_GOMC_REST_VERSION,
+    BusyError,
+    PLCClient,
+    PLCProtocolError,
+)
+
+with PLCClient("http://192.168.0.1:8080") as plc:
+    health = plc.health()
+    metrics = plc.metrics()
+    version = plc.version()
+    is_supported = plc.is_supported_version()
+    is_compatible = plc.is_version_compatible(MINIMUM_SUPPORTED_GOMC_REST_VERSION)
+    values = plc.read("D100", 3)
+    bits = plc.read("M0", 4)
+    dwords = plc.read("D100", 2, dword=True)
+    signed = plc.read("D100", 3, sint=True)
+
+    plc.write("D100", [10, 20, 30])
+    plc.write("M0", [True, False])
+    plc.write("D100", [-1, -32768, 32767], sint=True)
+
+    try:
+        plc.remote_run(clear=0, force=False)
+    except BusyError:
+        pass
+    except PLCProtocolError as exc:
+        print(exc.end_code, exc.message)
+```
+
+`is_supported_version()` and `is_version_compatible()` treat `dev` builds as compatible by default so local gomc-rest main builds can pass version checks during development.
+
+## Supported gomc-rest versions
+
+This client supports gomc-rest `v0.6.0` and later.
+
+Servers older than `v0.6.0` are not supported. In particular, servers without the `/version` endpoint are out of scope for this client.
+
+This client expects the server to expose both `/version` and `/metrics`.
+
+If you need to verify the support policy at runtime, call `plc.is_supported_version()` or compare against `MINIMUM_SUPPORTED_GOMC_REST_VERSION`.
+
+## API coverage
+
+- GET /version
+- GET /metrics
+- GET /health
+- GET /read
+- POST /write
+- POST /remote/run
+- POST /remote/stop
+- POST /remote/pause
+- POST /remote/latch-clear
+- POST /remote/reset
+
+Remote-control endpoints require the gomc-rest server to start with `-enable-remote`.
+
+## Development
+
+Run checks with uv:
+
+```bash
+uv run pytest
+uv run ruff check .
+uv run ty check
+uv build
+```
+
+To publish to PyPI after configuring credentials:
+
+```bash
+uv publish
+```

gomc_rest_client-0.1.0/gomc_rest_client/__init__.py

@@ -0,0 +1,26 @@
+from .client import MINIMUM_SUPPORTED_GOMC_REST_VERSION, PLCClient
+from .exceptions import (
+    BadRequestError,
+    BusyError,
+    ConnectionError,
+    ForbiddenError,
+    PLCError,
+    PLCProtocolError,
+    QueueClosedError,
+    RequestCanceledError,
+    RequestTimeoutError,
+)
+
+__all__ = [
+    "BadRequestError",
+    "BusyError",
+    "ConnectionError",
+    "ForbiddenError",
+    "MINIMUM_SUPPORTED_GOMC_REST_VERSION",
+    "PLCClient",
+    "PLCError",
+    "PLCProtocolError",
+    "QueueClosedError",
+    "RequestCanceledError",
+    "RequestTimeoutError",
+]