pyrcmclient

Name	pyrcmclient JSON
Version	0.0.11 JSON
	download
home_page	https://github.com/quatre-i-science/pyrcmclient
Summary	python client for i4s-rcm
upload_time	2024-12-20 06:54:37
maintainer	None
docs_url	None
author	quatre-i-science
requires_python	None
license	MIT
keywords	i4s rcm client
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # pyrcmclient

`pyrcmclient`は、I4S `RCM-Controller`のPythonクライアントです。Pythonから`DBリクエスト`や`RCMワークフロー`の実行などを簡単に行うことができます。

## 概要

Pythonを使用してRCM-Controllerの以下の機能をコールすることができます。

- **ログイン**: RCMアカウントにログインします
- **DBRequest**: データベースへのリクエストを送信し、データを操作することができます。
- **ファイル登録**: ファイルをRCMにアップロードします。
- **ファイル取得**: RCMからファイルをダウンロードします
- **RCM WorkFlow実行**: ワークフローの実行を簡潔なコードで行うことができます。
- **systemConfig**: RCM-Controllerの情報取得と設定変更

## インストール方法

以下のコマンドで`pyrcmclient`をインストールすることができます：

```sh
pip install pyrcmclient
```

## 使用方法

### DBRequestの例

以下に、データベースリクエストの簡単な使用例を示します：

```python
from i4srcm.client import RCMCNT_Client

client:RCMCNT_Client = RCMCNT_Client( "https://rcmfront", username="userName", passwd="passwd" )
if not client.login():
    print("failled to login")
    return
response = client.SEL2("/project[@tagid=1234]/template[name='abc']")
print(response)
```

### ワークフロー実行の例

RCM WorkFlowを実行するための例です：

```python
from i4srcm.client import RCMCNT_Client

client:RCMCNT_Client = RCMCNT_Client( "https://rcmfront", username="userName", passwd="passwd" )
if not client.login():
    print("failled to login")
    return

workflow_id = client.execute_template( "template name" )
workflow_result = client.get_workflow(workflow_id,wait=60)
print(workflow_result)
```

## 必要要件

- Python 3.11以上
- RCM-1024以降のバージョンのRCM-Controller

## ライセンス

このプロジェクトは[MITライセンス](LICENSE.txt)のもとで公開されています。

本モジュールの利用・運用の結果と起因する損害などについて開発元は一切の責任を負いません。

本モジュールについてのサポートは行いませんが、ご質問やご提案をいただければ開発の参考にさせて頂きます。


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/quatre-i-science/pyrcmclient",
    "name": "pyrcmclient",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "i4s rcm client",
    "author": "quatre-i-science",
    "author_email": "i4s_eng@i4s.co.jp",
    "download_url": null,
    "platform": null,
    "description": "# pyrcmclient\n\n`pyrcmclient`\u306f\u3001I4S `RCM-Controller`\u306ePython\u30af\u30e9\u30a4\u30a2\u30f3\u30c8\u3067\u3059\u3002Python\u304b\u3089`DB\u30ea\u30af\u30a8\u30b9\u30c8`\u3084`RCM\u30ef\u30fc\u30af\u30d5\u30ed\u30fc`\u306e\u5b9f\u884c\u306a\u3069\u3092\u7c21\u5358\u306b\u884c\u3046\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002\n\n## \u6982\u8981\n\nPython\u3092\u4f7f\u7528\u3057\u3066RCM-Controller\u306e\u4ee5\u4e0b\u306e\u6a5f\u80fd\u3092\u30b3\u30fc\u30eb\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002\n\n- **\u30ed\u30b0\u30a4\u30f3**: RCM\u30a2\u30ab\u30a6\u30f3\u30c8\u306b\u30ed\u30b0\u30a4\u30f3\u3057\u307e\u3059\n- **DBRequest**: \u30c7\u30fc\u30bf\u30d9\u30fc\u30b9\u3078\u306e\u30ea\u30af\u30a8\u30b9\u30c8\u3092\u9001\u4fe1\u3057\u3001\u30c7\u30fc\u30bf\u3092\u64cd\u4f5c\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002\n- **\u30d5\u30a1\u30a4\u30eb\u767b\u9332**: \u30d5\u30a1\u30a4\u30eb\u3092RCM\u306b\u30a2\u30c3\u30d7\u30ed\u30fc\u30c9\u3057\u307e\u3059\u3002\n- **\u30d5\u30a1\u30a4\u30eb\u53d6\u5f97**: RCM\u304b\u3089\u30d5\u30a1\u30a4\u30eb\u3092\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u3057\u307e\u3059\n- **RCM WorkFlow\u5b9f\u884c**: \u30ef\u30fc\u30af\u30d5\u30ed\u30fc\u306e\u5b9f\u884c\u3092\u7c21\u6f54\u306a\u30b3\u30fc\u30c9\u3067\u884c\u3046\u3053\u3068\u304c\u3067\u304d\u307e\u3059\u3002\n- **systemConfig**: RCM-Controller\u306e\u60c5\u5831\u53d6\u5f97\u3068\u8a2d\u5b9a\u5909\u66f4\n\n## \u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u65b9\u6cd5\n\n\u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3067`pyrcmclient`\u3092\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3059\u308b\u3053\u3068\u304c\u3067\u304d\u307e\u3059\uff1a\n\n```sh\npip install pyrcmclient\n```\n\n## \u4f7f\u7528\u65b9\u6cd5\n\n### DBRequest\u306e\u4f8b\n\n\u4ee5\u4e0b\u306b\u3001\u30c7\u30fc\u30bf\u30d9\u30fc\u30b9\u30ea\u30af\u30a8\u30b9\u30c8\u306e\u7c21\u5358\u306a\u4f7f\u7528\u4f8b\u3092\u793a\u3057\u307e\u3059\uff1a\n\n```python\nfrom i4srcm.client import RCMCNT_Client\n\nclient:RCMCNT_Client = RCMCNT_Client( \"https://rcmfront\", username=\"userName\", passwd=\"passwd\" )\nif not client.login():\n    print(\"failled to login\")\n    return\nresponse = client.SEL2(\"/project[@tagid=1234]/template[name='abc']\")\nprint(response)\n```\n\n### \u30ef\u30fc\u30af\u30d5\u30ed\u30fc\u5b9f\u884c\u306e\u4f8b\n\nRCM WorkFlow\u3092\u5b9f\u884c\u3059\u308b\u305f\u3081\u306e\u4f8b\u3067\u3059\uff1a\n\n```python\nfrom i4srcm.client import RCMCNT_Client\n\nclient:RCMCNT_Client = RCMCNT_Client( \"https://rcmfront\", username=\"userName\", passwd=\"passwd\" )\nif not client.login():\n    print(\"failled to login\")\n    return\n\nworkflow_id = client.execute_template( \"template name\" )\nworkflow_result = client.get_workflow(workflow_id,wait=60)\nprint(workflow_result)\n```\n\n## \u5fc5\u8981\u8981\u4ef6\n\n- Python 3.11\u4ee5\u4e0a\n- RCM-1024\u4ee5\u964d\u306e\u30d0\u30fc\u30b8\u30e7\u30f3\u306eRCM-Controller\n\n## \u30e9\u30a4\u30bb\u30f3\u30b9\n\n\u3053\u306e\u30d7\u30ed\u30b8\u30a7\u30af\u30c8\u306f[MIT\u30e9\u30a4\u30bb\u30f3\u30b9](LICENSE.txt)\u306e\u3082\u3068\u3067\u516c\u958b\u3055\u308c\u3066\u3044\u307e\u3059\u3002\n\n\u672c\u30e2\u30b8\u30e5\u30fc\u30eb\u306e\u5229\u7528\u30fb\u904b\u7528\u306e\u7d50\u679c\u3068\u8d77\u56e0\u3059\u308b\u640d\u5bb3\u306a\u3069\u306b\u3064\u3044\u3066\u958b\u767a\u5143\u306f\u4e00\u5207\u306e\u8cac\u4efb\u3092\u8ca0\u3044\u307e\u305b\u3093\u3002\n\n\u672c\u30e2\u30b8\u30e5\u30fc\u30eb\u306b\u3064\u3044\u3066\u306e\u30b5\u30dd\u30fc\u30c8\u306f\u884c\u3044\u307e\u305b\u3093\u304c\u3001\u3054\u8cea\u554f\u3084\u3054\u63d0\u6848\u3092\u3044\u305f\u3060\u3051\u308c\u3070\u958b\u767a\u306e\u53c2\u8003\u306b\u3055\u305b\u3066\u9802\u304d\u307e\u3059\u3002\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "python client for i4s-rcm",
    "version": "0.0.11",
    "project_urls": {
        "Homepage": "https://github.com/quatre-i-science/pyrcmclient"
    },
    "split_keywords": [
        "i4s",
        "rcm",
        "client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e68b5d9f6709648ca0791dbf1e6cfbbb97d46313ad8a8a2998f0c1d72d7ac817",
                "md5": "ef0fd9856812b367dada35ed72161171",
                "sha256": "25e3ffd0936f1c8bf02843951f809b2ff5b662adb528042c376c97034479e22c"
            },
            "downloads": -1,
            "filename": "pyrcmclient-0.0.11-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ef0fd9856812b367dada35ed72161171",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 74324,
            "upload_time": "2024-12-20T06:54:37",
            "upload_time_iso_8601": "2024-12-20T06:54:37.624566Z",
            "url": "https://files.pythonhosted.org/packages/e6/8b/5d9f6709648ca0791dbf1e6cfbbb97d46313ad8a8a2998f0c1d72d7ac817/pyrcmclient-0.0.11-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-20 06:54:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "quatre-i-science",
    "github_project": "pyrcmclient",
    "github_not_found": true,
    "lcname": "pyrcmclient"
}