teaching-manager 0.0.0__tar.gz

teaching_manager-0.0.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.

teaching_manager-0.0.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: teaching-manager
+Version: 0.0.0
+Summary: teaching manager
+Author-email: Kengo NAKADA <kengo.nakada@email.com>
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: xlogger-py
+Requires-Dist: pyside6
+Requires-Dist: setuptools
+Requires-Dist: python-dotenv
+Requires-Dist: fastapi
+Requires-Dist: fastapi-utils
+Requires-Dist: uvicorn
+Requires-Dist: pydantic
+Requires-Dist: starlette
+Requires-Dist: requests
+Requires-Dist: aiohttp
+Requires-Dist: httpx
+Requires-Dist: pywin32; sys_platform == "win32"
+Requires-Dist: pygame; sys_platform == "win32"
+Requires-Dist: coloredlogs
+Requires-Dist: colorlog
+Requires-Dist: pytest
+Requires-Dist: pytest-asyncio
+Requires-Dist: pyyaml
+Requires-Dist: toml
+Requires-Dist: tomli; python_version < "3.11"
+Requires-Dist: importlib-metadata>=4.0; python_version < "3.8"
+Requires-Dist: nest_asyncio
+Requires-Dist: sphinx
+Requires-Dist: myst-parser
+Requires-Dist: sphinx-autobuild
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: sphinxcontrib-napoleon
+Requires-Dist: linkify-it-py
+Requires-Dist: grpcio
+Requires-Dist: grpcio-tools
+Requires-Dist: google
+Requires-Dist: pygame
+Dynamic: license-file
+
+# Robot Teaching Manager
+
+[![en](https://img.shields.io/badge/lang-en-red.svg)](https://github.com/ohara-lab-su/teaching_manager/blob/main/README.en.md)
+[![ja](https://img.shields.io/badge/lang-ja-yellow.svg)](https://github.com/ohara-lab-su/teaching_manager/blob/main/README.md)
+
+ロボットの現在位置を P 変数として登録・確認し、JSON ファイルで管理する Qt ベースのティーチング GUI です。
+
+**バージョン: 0.0.0（初期版）**
+
+## 主な機能
+
+- ロボットの現在位置を取得して表示します。
+- P 番号と座標の一覧を表示します。P 番号範囲を指定して読み込めます（Cobotta）。
+- 指定した P 番号、または一覧で選択した P 番号に **取得済みの現在位置**を書き込みます。書き込み前に確認します。
+- 一覧の右クリックメニューから、現在位置の書き込み、 **0 クリア**、 **一覧から削除**を実行できます。
+- Ctrl／Command による複数行選択と Shift による範囲選択に対応します。0 クリアと一覧から削除は複数行をまとめて操作できます。
+- 0 クリアは対象 P 番号を `[0, 0, 0, 0, 0, 0, -1]` に設定します。
+- JSON ファイルからの読み込み、表示中の一覧の JSON 保存に対応します。
+
+**注意:** 「空き番号にティーチング」ボタンはありますが、未使用番号の判定仕様が未確定のため、自動登録は実行できません。
+
+## デバイスごとの保存先
+
+`DeviceProxy` に渡す `device_name` で自動的に切り替わります。名前の比較は **`CobottaCtrl` と完全一致**です。
+
+| 操作                 | `CobottaCtrl`                    | その他のデバイス名     |
+|----------------------|----------------------------------|------------------------|
+| 起動時の P 変数読込  | ロボット内部 P 変数              | JSON ファイル          |
+| 現在位置の取得       | ロボット API                     | ロボット API           |
+| 現在位置の登録       | ロボット内部 P 変数              | JSON に自動保存        |
+| 0 クリア             | ロボット内部 P 変数              | JSON に自動保存        |
+| 一覧から削除         | 表示一覧のみ（実機は変更しない） | 表示一覧と JSON        |
+| 「JSONに保存」ボタン | 表示一覧を JSON に保存           | 表示一覧を JSON に保存 |
+
+Cobotta の実機 P 変数の変更は JSON に自動保存されません。その他のデバイスでは、P 変数をロボット内部メモリに保存せず、JSON
+を利用します。 **現在位置の取得には、どちらの場合も接続済みのロボットが必要です。**
+
+## 構成
+
+| ファイル                                      | 役割                                        |
+|-----------------------------------------------|---------------------------------------------|
+| `example/teaching_gui.py`                     | PySide6 の画面・操作・確認ダイアログ        |
+| `src/teaching_manager/teaching_controller.py` | デバイス名による保存先選択と操作の振り分け  |
+| `src/teaching_manager/teaching_model.py`      | P 変数・現在位置・ロボット API・JSON の処理 |
+| `src/teaching_manager/robot_var_manager.py`   | ローカル変数管理                            |
+
+GUI、Controller、Model を分離した MVC 構成です。
+
+## 起動と設定
+
+現行の `example/teaching_gui.py` は `PySide6`、`x_logger`、`cobotta2` を import
+します。これらのパッケージと接続先の設定ファイルを、使用環境に合わせて用意してください。依存関係を宣言するパッケージ設定ファイルは今回の確認対象に含まれていないため、対応バージョンはここでは規定しません。
+
+`example/teaching_gui.py` の `main()` で、`Config("config_cobotta3_server5.yaml")`、`device_name = "CobottaCtrl"`、
+`DeviceProxy(...)` を設定します。JSON の保存先は同ファイル内の `JSON_FILE` で、初期値はプロジェクトルートの
+`robot_positions.json` です。P 番号の GUI 入力範囲は 0〜999、起動時の読込範囲の初期値は P0〜P20 です。
+
+プロジェクトルートからの実行例:
+
+```sh
+python example/teaching_gui.py
+```
+
+ロボット通信が必要な操作は、対応する DeviceProxy とサーバーが利用可能な状態で実行してください。
+
+## 操作上の注意
+
+- 書き込み・0 クリアは既存の座標を上書きします。確認ダイアログで対象を確認してください。
+- Cobotta の「一覧から削除」はロボット内部 P 変数を消去しません。0 クリアとは別操作です。
+- JSON 管理モードの「一覧から削除」は JSON にも反映されます。
+- ロボットへの書き込み後は P 変数を読み戻して検証します。
+- 現在位置の取得中に画面を閉じると、通信スレッドの終了待ちが発生する場合があります。
+
+## 更新履歴
+
+[CHANGELOG.md](CHANGELOG.md) / [CHANGELOG.en.md](CHANGELOG.en.md)

teaching_manager-0.0.0/README.md

@@ -0,0 +1,76 @@
+# Robot Teaching Manager
+
+[![en](https://img.shields.io/badge/lang-en-red.svg)](https://github.com/ohara-lab-su/teaching_manager/blob/main/README.en.md)
+[![ja](https://img.shields.io/badge/lang-ja-yellow.svg)](https://github.com/ohara-lab-su/teaching_manager/blob/main/README.md)
+
+ロボットの現在位置を P 変数として登録・確認し、JSON ファイルで管理する Qt ベースのティーチング GUI です。
+
+**バージョン: 0.0.0（初期版）**
+
+## 主な機能
+
+- ロボットの現在位置を取得して表示します。
+- P 番号と座標の一覧を表示します。P 番号範囲を指定して読み込めます（Cobotta）。
+- 指定した P 番号、または一覧で選択した P 番号に **取得済みの現在位置**を書き込みます。書き込み前に確認します。
+- 一覧の右クリックメニューから、現在位置の書き込み、 **0 クリア**、 **一覧から削除**を実行できます。
+- Ctrl／Command による複数行選択と Shift による範囲選択に対応します。0 クリアと一覧から削除は複数行をまとめて操作できます。
+- 0 クリアは対象 P 番号を `[0, 0, 0, 0, 0, 0, -1]` に設定します。
+- JSON ファイルからの読み込み、表示中の一覧の JSON 保存に対応します。
+
+**注意:** 「空き番号にティーチング」ボタンはありますが、未使用番号の判定仕様が未確定のため、自動登録は実行できません。
+
+## デバイスごとの保存先
+
+`DeviceProxy` に渡す `device_name` で自動的に切り替わります。名前の比較は **`CobottaCtrl` と完全一致**です。
+
+| 操作                 | `CobottaCtrl`                    | その他のデバイス名     |
+|----------------------|----------------------------------|------------------------|
+| 起動時の P 変数読込  | ロボット内部 P 変数              | JSON ファイル          |
+| 現在位置の取得       | ロボット API                     | ロボット API           |
+| 現在位置の登録       | ロボット内部 P 変数              | JSON に自動保存        |
+| 0 クリア             | ロボット内部 P 変数              | JSON に自動保存        |
+| 一覧から削除         | 表示一覧のみ（実機は変更しない） | 表示一覧と JSON        |
+| 「JSONに保存」ボタン | 表示一覧を JSON に保存           | 表示一覧を JSON に保存 |
+
+Cobotta の実機 P 変数の変更は JSON に自動保存されません。その他のデバイスでは、P 変数をロボット内部メモリに保存せず、JSON
+を利用します。 **現在位置の取得には、どちらの場合も接続済みのロボットが必要です。**
+
+## 構成
+
+| ファイル                                      | 役割                                        |
+|-----------------------------------------------|---------------------------------------------|
+| `example/teaching_gui.py`                     | PySide6 の画面・操作・確認ダイアログ        |
+| `src/teaching_manager/teaching_controller.py` | デバイス名による保存先選択と操作の振り分け  |
+| `src/teaching_manager/teaching_model.py`      | P 変数・現在位置・ロボット API・JSON の処理 |
+| `src/teaching_manager/robot_var_manager.py`   | ローカル変数管理                            |
+
+GUI、Controller、Model を分離した MVC 構成です。
+
+## 起動と設定
+
+現行の `example/teaching_gui.py` は `PySide6`、`x_logger`、`cobotta2` を import
+します。これらのパッケージと接続先の設定ファイルを、使用環境に合わせて用意してください。依存関係を宣言するパッケージ設定ファイルは今回の確認対象に含まれていないため、対応バージョンはここでは規定しません。
+
+`example/teaching_gui.py` の `main()` で、`Config("config_cobotta3_server5.yaml")`、`device_name = "CobottaCtrl"`、
+`DeviceProxy(...)` を設定します。JSON の保存先は同ファイル内の `JSON_FILE` で、初期値はプロジェクトルートの
+`robot_positions.json` です。P 番号の GUI 入力範囲は 0〜999、起動時の読込範囲の初期値は P0〜P20 です。
+
+プロジェクトルートからの実行例:
+
+```sh
+python example/teaching_gui.py
+```
+
+ロボット通信が必要な操作は、対応する DeviceProxy とサーバーが利用可能な状態で実行してください。
+
+## 操作上の注意
+
+- 書き込み・0 クリアは既存の座標を上書きします。確認ダイアログで対象を確認してください。
+- Cobotta の「一覧から削除」はロボット内部 P 変数を消去しません。0 クリアとは別操作です。
+- JSON 管理モードの「一覧から削除」は JSON にも反映されます。
+- ロボットへの書き込み後は P 変数を読み戻して検証します。
+- 現在位置の取得中に画面を閉じると、通信スレッドの終了待ちが発生する場合があります。
+
+## 更新履歴
+
+[CHANGELOG.md](CHANGELOG.md) / [CHANGELOG.en.md](CHANGELOG.en.md)

teaching_manager-0.0.0/pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "teaching-manager"
+
+version = "0.0.0"
+
+description = "teaching manager"
+authors = [
+    { name = "Kengo NAKADA", email = "kengo.nakada@email.com" }
+]
+readme = "README.md"
+requires-python = ">=3.7"
+#requires-python = ">=3.8"
+#requires-python = ">=3.11"
+dependencies = [
+    #"x_logger",
+    "xlogger-py",
+    #
+    "pyside6",
+    #
+    "setuptools",
+    "python-dotenv",
+    "fastapi",
+    "fastapi-utils",
+    "uvicorn",
+    "pydantic",
+    "starlette",
+    "requests",
+    "aiohttp",
+    "httpx",
+    "pywin32; sys_platform == 'win32'",
+    "pygame; sys_platform == 'win32'",
+    "coloredlogs",
+    "colorlog",
+    #
+    "pytest",
+    "pytest-asyncio",
+    #
+    "pyyaml",
+    "toml",
+    "tomli; python_version < '3.11'",
+    #
+    "importlib-metadata>=4.0; python_version < '3.8'",
+    #
+    "nest_asyncio",
+    "sphinx",
+    "myst-parser",
+    "sphinx-autobuild",
+    "sphinx-rtd-theme",
+    "sphinxcontrib-napoleon",
+    "linkify-it-py",
+    #
+    "grpcio",
+    "grpcio-tools",
+    "google",
+    "pygame",
+]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+# ここでpytestのiniと同じようにオプションが書ける
+# 例えばテストマーク、フィルタ、カバレッジなども追記可能
+
+[tool.black]
+line-length = 88
+
+[tool.isort]
+profile = "black"

teaching_manager-0.0.0/setup.cfg

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