codesys-tools 0.2.0__tar.gz

codesys_tools-0.2.0/LICENSE

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

codesys_tools-0.2.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: codesys-tools
+Version: 0.2.0
+Summary: Windows-first CODESYS automation tools with a local CLI and HTTP server
+Author: codesys-tools maintainers
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Zhgong/codesys-api
+Project-URL: Repository, https://github.com/Zhgong/codesys-api
+Project-URL: Issues, https://github.com/Zhgong/codesys-api/issues
+Project-URL: Documentation, https://github.com/Zhgong/codesys-api/tree/main/docs
+Keywords: codesys,plc,industrial-automation,cli,tooling
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Scientific/Engineering
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pywin32
+Dynamic: license-file
+
+# codesys-tools
+
+Windows-first, experimental local automation tooling for CODESYS.
+
+`codesys-tools` provides:
+
+- a local CLI: `codesys-tools`
+- a local HTTP server: `codesys-tools-server`
+- a persistent CODESYS runtime built around `named_pipe`
+
+## Support Boundary
+
+This project is currently published as:
+
+- Windows-only
+- experimental
+- intended for local CODESYS installations
+
+Current assumptions:
+
+- CODESYS must already be installed on the target machine
+- the runtime transport is `named_pipe` only
+- the package does not include a bundled CODESYS runtime
+- public release prep is in place, but the project is not yet committed to cross-platform support
+
+## Installation
+
+For local development:
+
+```powershell
+pip install .
+```
+
+For release artifacts:
+
+```powershell
+python scripts\build_release.py
+python -m pip install dist\codesys_tools-*.whl
+```
+
+## Required Environment
+
+At minimum, local CODESYS usage requires:
+
+- `CODESYS_API_CODESYS_PATH`
+- `CODESYS_API_CODESYS_PROFILE`
+- `CODESYS_API_CODESYS_PROFILE_PATH`
+
+The CLI and server both use the same runtime wiring and packaged assets.
+
+## Quick Start
+
+CLI:
+
+```powershell
+codesys-tools --help
+codesys-tools session start
+codesys-tools project create --path C:\work\demo.project
+codesys-tools project compile
+codesys-tools project close
+codesys-tools session stop
+```
+
+Server:
+
+```powershell
+codesys-tools-server --help
+python HTTP_SERVER.py
+```
+
+Repo-local compatibility entrypoints remain available:
+
+- `python codesys_cli.py ...`
+- `python HTTP_SERVER.py`
+- `run_cli.bat ...`
+
+## What It Does
+
+- starts and stops a local persistent CODESYS session
+- creates, opens, saves, closes, and compiles projects
+- creates and edits POUs
+- exposes the same core actions through both CLI and HTTP entrypoints
+
+Compile validation currently uses:
+
+- build
+- generate code
+
+## Validation Status
+
+Current local engineering baseline:
+
+- `python scripts\run_baseline.py`
+- latest expected result: `170 passed, 8 skipped`
+
+Current release validation:
+
+- `python scripts\build_release.py`
+- clean wheel-install smoke
+- packaged asset lookup smoke
+- GitHub Actions CI and manual release workflows
+
+## Documentation
+
+- [docs/CLI_USAGE.md](docs/CLI_USAGE.md): CLI commands and examples
+- [docs/INSTALLATION_GUIDE.md](docs/INSTALLATION_GUIDE.md): installation and local setup
+- [docs/PACKAGING.md](docs/PACKAGING.md): build and wheel verification flow
+- [docs/RELEASE.md](docs/RELEASE.md): internal wheel release checklist
+- [docs/PUBLIC_RELEASE.md](docs/PUBLIC_RELEASE.md): public release preparation checklist
+- [docs/BASELINE.md](docs/BASELINE.md): baseline gates and validation commands
+- [.github/workflows](.github/workflows): CI, release-build, and manual publish workflows
+
+## Not Included
+
+This project does not currently provide:
+
+- a hosted/cloud service
+- cross-platform support
+- a bundled CODESYS installation
+- an installer
+- public API stability guarantees beyond the current local tooling contract
+
+## License
+
+MIT. See [LICENSE](LICENSE).

codesys_tools-0.2.0/README.md

@@ -0,0 +1,125 @@
+# codesys-tools
+
+Windows-first, experimental local automation tooling for CODESYS.
+
+`codesys-tools` provides:
+
+- a local CLI: `codesys-tools`
+- a local HTTP server: `codesys-tools-server`
+- a persistent CODESYS runtime built around `named_pipe`
+
+## Support Boundary
+
+This project is currently published as:
+
+- Windows-only
+- experimental
+- intended for local CODESYS installations
+
+Current assumptions:
+
+- CODESYS must already be installed on the target machine
+- the runtime transport is `named_pipe` only
+- the package does not include a bundled CODESYS runtime
+- public release prep is in place, but the project is not yet committed to cross-platform support
+
+## Installation
+
+For local development:
+
+```powershell
+pip install .
+```
+
+For release artifacts:
+
+```powershell
+python scripts\build_release.py
+python -m pip install dist\codesys_tools-*.whl
+```
+
+## Required Environment
+
+At minimum, local CODESYS usage requires:
+
+- `CODESYS_API_CODESYS_PATH`
+- `CODESYS_API_CODESYS_PROFILE`
+- `CODESYS_API_CODESYS_PROFILE_PATH`
+
+The CLI and server both use the same runtime wiring and packaged assets.
+
+## Quick Start
+
+CLI:
+
+```powershell
+codesys-tools --help
+codesys-tools session start
+codesys-tools project create --path C:\work\demo.project
+codesys-tools project compile
+codesys-tools project close
+codesys-tools session stop
+```
+
+Server:
+
+```powershell
+codesys-tools-server --help
+python HTTP_SERVER.py
+```
+
+Repo-local compatibility entrypoints remain available:
+
+- `python codesys_cli.py ...`
+- `python HTTP_SERVER.py`
+- `run_cli.bat ...`
+
+## What It Does
+
+- starts and stops a local persistent CODESYS session
+- creates, opens, saves, closes, and compiles projects
+- creates and edits POUs
+- exposes the same core actions through both CLI and HTTP entrypoints
+
+Compile validation currently uses:
+
+- build
+- generate code
+
+## Validation Status
+
+Current local engineering baseline:
+
+- `python scripts\run_baseline.py`
+- latest expected result: `170 passed, 8 skipped`
+
+Current release validation:
+
+- `python scripts\build_release.py`
+- clean wheel-install smoke
+- packaged asset lookup smoke
+- GitHub Actions CI and manual release workflows
+
+## Documentation
+
+- [docs/CLI_USAGE.md](docs/CLI_USAGE.md): CLI commands and examples
+- [docs/INSTALLATION_GUIDE.md](docs/INSTALLATION_GUIDE.md): installation and local setup
+- [docs/PACKAGING.md](docs/PACKAGING.md): build and wheel verification flow
+- [docs/RELEASE.md](docs/RELEASE.md): internal wheel release checklist
+- [docs/PUBLIC_RELEASE.md](docs/PUBLIC_RELEASE.md): public release preparation checklist
+- [docs/BASELINE.md](docs/BASELINE.md): baseline gates and validation commands
+- [.github/workflows](.github/workflows): CI, release-build, and manual publish workflows
+
+## Not Included
+
+This project does not currently provide:
+
+- a hosted/cloud service
+- cross-platform support
+- a bundled CODESYS installation
+- an installer
+- public API stability guarantees beyond the current local tooling contract
+
+## License
+
+MIT. See [LICENSE](LICENSE).

codesys_tools-0.2.0/pyproject.toml

@@ -0,0 +1,95 @@
+[build-system]
+requires = ["setuptools>=70", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "codesys-tools"
+version = "0.2.0"
+description = "Windows-first CODESYS automation tools with a local CLI and HTTP server"
+readme = "README.md"
+requires-python = ">=3.14"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "codesys-tools maintainers" },
+]
+keywords = ["codesys", "plc", "industrial-automation", "cli", "tooling"]
+dependencies = [
+    "requests",
+    "pywin32",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Scientific/Engineering",
+]
+
+[project.urls]
+Homepage = "https://github.com/Zhgong/codesys-api"
+Repository = "https://github.com/Zhgong/codesys-api"
+Issues = "https://github.com/Zhgong/codesys-api/issues"
+Documentation = "https://github.com/Zhgong/codesys-api/tree/main/docs"
+
+[project.scripts]
+codesys-tools = "codesys_api.cli_entry:main"
+codesys-tools-server = "codesys_api.server_entry:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+codesys_api = [
+    "py.typed",
+    "assets/PERSISTENT_SESSION.py",
+    "assets/ScriptLib/**/*",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+addopts = "-ra"
+markers = [
+    "mock: tests that exercise the mock HTTP server without a CODESYS installation",
+    "codesys: tests that require a real CODESYS installation",
+    "codesys_main: fast real-CODESYS acceptance path that minimizes cold starts",
+    "codesys_slow: slower real-CODESYS runtime hardening checks",
+]
+
+[tool.mypy]
+python_version = "3.14"
+strict = true
+warn_unused_configs = true
+mypy_path = ["src"]
+exclude = "^src/codesys_api/assets/"
+files = [
+    "_repo_bootstrap.py",
+    "src/codesys_api",
+    "codesys_cli.py",
+    "HTTP_SERVER.py",
+    "scripts/dev/test_server.py",
+    "scripts/build_release.py",
+    "scripts/check_public_release.py",
+    "scripts/verify_installed_package.py",
+    "scripts/run_baseline.py",
+    "tests/integration",
+    "tests/unit",
+    "tests/e2e/codesys",
+    "tests/e2e/mock",
+]
+
+[[tool.mypy.overrides]]
+module = [
+    "HTTP_SERVER",
+    "PERSISTENT_SESSION",
+    "test_server",
+    "codesys_api.http_server",
+    "codesys_api.server_entry",
+]
+ignore_errors = true

codesys_tools-0.2.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

codesys_tools-0.2.0/src/codesys_api/__init__.py

@@ -0,0 +1,2 @@
+"""Structured package for the host-side CODESYS API implementation."""
+