[](https://badge.fury.io/py/signate)
# **SIGNATE CLI**
[SIGNATE](https://user.competition.signate.jp) の公式APIコマンドラインインターフェイス(以下：SIGNATE CLI)です。
SIGNATEはData Science Competitionのご提供を始めとした、データサイエンティストの皆様のための統合プラットフォームです。
**※SIGNATE CLIの動作にはPython3.8 以降の環境が必要です。**
※当CLIはβ版であり、予告なく変更させていただく可能性がございます。予めご了承ください。
※SIGNATE CLIはMac OSおよびLinuxをサポートしております。
# **インストールと事前準備**
以下のコマンドでインストールをお願いいたします。
```
$ pip install signate
```
インストール後、以下の手順を実施ください。
1. [SIGNATE](https://user.competition.signate.jp) でアカウント登録 ※メールアドレス/パスワード 認証でのみ SIGNATE CLIをご利用いただけます。
2. 以下のコマンドで登録したメールアドレス指定して実行
```
$ signate token -e xxxxx@example.co.jp
```
3. パスワードを入力してサインイン（入力値は表示されません）
```
Password:
```
4. 以下のメッセージが表示されたら利用準備完了です。
```
The API Token has been downloaded successfully.
```
``signate: command not found`` と表示される場合、環境変数$PATH のディレクトリ内にsignateが存在していることをご確認ください。``pip uninstall signate``コマンドで
- signateコマンドがインストールされているディレクトリの確認
- signateコマンドのアンインストール
が可能です。
# **利用方法**
SIGNATE CLIでは以下の機能が利用できます。
```bash
$ signate --help
Usage: signate [OPTIONS] COMMAND [ARGS]...
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
competition-list
download
file-list
submit
task-list
token
```
### **① 投稿可能なコンペティション一覧の取得**
```
$ signate competition-list
```
投稿可能なコンペティション一覧を表示します。
``` bash
$ signate competition-list
public_key title remaining reward entry_count
-------------------------------- ------------------ ------------- ------------- -------------
0001d2723faa40b5a597832319f4722c コンペティション1 360 seconds 100万円 1
c1001e081ca645dd9eb5c5a027fd8ecd コンペティション2 26 days 5
```
### **② 投稿可能な課題一覧の取得**
```
$ signate task-list --competition_key=<competition-key>
```
投稿可能な課題一覧を表示します。
``` bash
$ signate task-list --competition_key=<competition-key>
public_key task_name
-------------------------------- -----------
4d63b1cf2dd3462d902ac805f60d96ca 分類課題 データ1
4d63b1cf2dawega346gg02awe60d96cb 回帰課題 データ2
```
### **③ コンペティションが提供するファイル一覧の取得**
**こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。**
コンペティションへの参加はブラウザから実行してください。
```
$ signate file-list --task_key=<task-key>
```
課題のファイル一覧を表示します。
``` bash
$ signate file-list --task_key=<task-key>
public_key file_name title file_size
-------------------------------- --------------------- --------------------- -----------
sa9bc5b1f9ef45f6b79bdbeb281895f3 sample1.zip 学習用画像データ 60.65 MB
g5609de723b148fe8635754dcd1706fa test_images.zip 評価用画像データ 26.49 MB
```
### **④ コンペティションが提供するファイルのダウンロード**
**こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。**
コンペティションへの参加はブラウザから実行してください。
```
$ signate download --task_key=<task-key> --file_key=<file-key> [--path=<path>]
```
ファイルをダウンロードします。
デフォルトではカレントディレクトリにファイルがダウンロードされます。
`--path=`を指定すると、ダウンロード先のパスを指定できます。
``` bash
$ signate download --task_key=<task-key> --file_key=<file-key> --path=/tmp/test.zip
```
### **⑤ 投稿の実施**
**こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。**
コンペティションへの参加はブラウザから実行してください。
```
$ signate submit --task_key=<task-key> <結果ファイルのパス> --memo “comment”
```
コンペティションに投稿を実施します。
``` bash
$ signate submit --task_key=<task-key> ~/test.zip --memo "xxx"
Submission completed successfully.
```
### **補足**
#### コンペティションへの同意
以下のようなメッセージが出力された際は
```
If you haven’t joined the competition yet, please do so through your browser.
```
ブラウザにて該当コンペティションに参加をお願いいたします。
# **ライセンス**
SIGNATE CLIは[Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). を適用しております。
Raw data
{
"_id": null,
"home_page": "https://user.competition.signate.jp",
"name": "signate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "signate, signate-cli",
"author": "SIGNATE Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/13/c6/da439706a02bc916c82edf190904d461349c4f5c31ceb1efc2aaf240e644/signate-0.10.4.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/signate)\n\n# **SIGNATE CLI**\n[SIGNATE](https://user.competition.signate.jp) \u306e\u516c\u5f0fAPI\u30b3\u30de\u30f3\u30c9\u30e9\u30a4\u30f3\u30a4\u30f3\u30bf\u30fc\u30d5\u30a7\u30a4\u30b9(\u4ee5\u4e0b\uff1aSIGNATE CLI)\u3067\u3059\u3002\nSIGNATE\u306fData Science Competition\u306e\u3054\u63d0\u4f9b\u3092\u59cb\u3081\u3068\u3057\u305f\u3001\u30c7\u30fc\u30bf\u30b5\u30a4\u30a8\u30f3\u30c6\u30a3\u30b9\u30c8\u306e\u7686\u69d8\u306e\u305f\u3081\u306e\u7d71\u5408\u30d7\u30e9\u30c3\u30c8\u30d5\u30a9\u30fc\u30e0\u3067\u3059\u3002\n\n**\u203bSIGNATE CLI\u306e\u52d5\u4f5c\u306b\u306fPython3.8 \u4ee5\u964d\u306e\u74b0\u5883\u304c\u5fc5\u8981\u3067\u3059\u3002**\n\u203b\u5f53CLI\u306f\u03b2\u7248\u3067\u3042\u308a\u3001\u4e88\u544a\u306a\u304f\u5909\u66f4\u3055\u305b\u3066\u3044\u305f\u3060\u304f\u53ef\u80fd\u6027\u304c\u3054\u3056\u3044\u307e\u3059\u3002\u4e88\u3081\u3054\u4e86\u627f\u304f\u3060\u3055\u3044\u3002\n\u203bSIGNATE CLI\u306fMac OS\u304a\u3088\u3073Linux\u3092\u30b5\u30dd\u30fc\u30c8\u3057\u3066\u304a\u308a\u307e\u3059\u3002\n\n# **\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3068\u4e8b\u524d\u6e96\u5099**\n\n\u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3067\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3092\u304a\u9858\u3044\u3044\u305f\u3057\u307e\u3059\u3002\n\n```\n$ pip install signate\n```\n\n\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u5f8c\u3001\u4ee5\u4e0b\u306e\u624b\u9806\u3092\u5b9f\u65bd\u304f\u3060\u3055\u3044\u3002\n\n 1. [SIGNATE](https://user.competition.signate.jp) \u3067\u30a2\u30ab\u30a6\u30f3\u30c8\u767b\u9332 \u203b\u30e1\u30fc\u30eb\u30a2\u30c9\u30ec\u30b9/\u30d1\u30b9\u30ef\u30fc\u30c9 \u8a8d\u8a3c\u3067\u306e\u307f SIGNATE CLI\u3092\u3054\u5229\u7528\u3044\u305f\u3060\u3051\u307e\u3059\u3002\n 2. \u4ee5\u4e0b\u306e\u30b3\u30de\u30f3\u30c9\u3067\u767b\u9332\u3057\u305f\u30e1\u30fc\u30eb\u30a2\u30c9\u30ec\u30b9\u6307\u5b9a\u3057\u3066\u5b9f\u884c\n\n```\n$ signate token -e xxxxx@example.co.jp\n```\n 3. \u30d1\u30b9\u30ef\u30fc\u30c9\u3092\u5165\u529b\u3057\u3066\u30b5\u30a4\u30f3\u30a4\u30f3\uff08\u5165\u529b\u5024\u306f\u8868\u793a\u3055\u308c\u307e\u305b\u3093\uff09\n\n```\nPassword:\n```\n 4. \u4ee5\u4e0b\u306e\u30e1\u30c3\u30bb\u30fc\u30b8\u304c\u8868\u793a\u3055\u308c\u305f\u3089\u5229\u7528\u6e96\u5099\u5b8c\u4e86\u3067\u3059\u3002\n\n```\nThe API Token has been downloaded successfully.\n```\n\n``signate: command not found`` \u3068\u8868\u793a\u3055\u308c\u308b\u5834\u5408\u3001\u74b0\u5883\u5909\u6570$PATH \u306e\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u5185\u306bsignate\u304c\u5b58\u5728\u3057\u3066\u3044\u308b\u3053\u3068\u3092\u3054\u78ba\u8a8d\u304f\u3060\u3055\u3044\u3002``pip uninstall signate``\u30b3\u30de\u30f3\u30c9\u3067\n\n - signate\u30b3\u30de\u30f3\u30c9\u304c\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\u3055\u308c\u3066\u3044\u308b\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306e\u78ba\u8a8d\n - signate\u30b3\u30de\u30f3\u30c9\u306e\u30a2\u30f3\u30a4\u30f3\u30b9\u30c8\u30fc\u30eb\n\n\u304c\u53ef\u80fd\u3067\u3059\u3002\n\n# **\u5229\u7528\u65b9\u6cd5**\nSIGNATE CLI\u3067\u306f\u4ee5\u4e0b\u306e\u6a5f\u80fd\u304c\u5229\u7528\u3067\u304d\u307e\u3059\u3002\n\n```bash\n$ signate --help\nUsage: signate [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --version Show the version and exit.\n --help Show this message and exit.\n\nCommands:\n competition-list\n download\n file-list\n submit\n task-list\n token\n```\n\n### **\u2460 \u6295\u7a3f\u53ef\u80fd\u306a\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u4e00\u89a7\u306e\u53d6\u5f97**\n```\n$ signate competition-list\n```\n\u6295\u7a3f\u53ef\u80fd\u306a\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u4e00\u89a7\u3092\u8868\u793a\u3057\u307e\u3059\u3002\n\n``` bash\n$ signate competition-list\n\npublic_key title remaining reward entry_count\n-------------------------------- ------------------ ------------- ------------- -------------\n0001d2723faa40b5a597832319f4722c \u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f31 360 seconds 100\u4e07\u5186 1\nc1001e081ca645dd9eb5c5a027fd8ecd \u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f32 26 days 5\n```\n\n### **\u2461 \u6295\u7a3f\u53ef\u80fd\u306a\u8ab2\u984c\u4e00\u89a7\u306e\u53d6\u5f97**\n```\n$ signate task-list --competition_key=<competition-key>\n```\n\u6295\u7a3f\u53ef\u80fd\u306a\u8ab2\u984c\u4e00\u89a7\u3092\u8868\u793a\u3057\u307e\u3059\u3002\n\n``` bash\n$ signate task-list --competition_key=<competition-key>\n\npublic_key task_name\n-------------------------------- -----------\n4d63b1cf2dd3462d902ac805f60d96ca \u5206\u985e\u8ab2\u984c \u30c7\u30fc\u30bf1\n4d63b1cf2dawega346gg02awe60d96cb \u56de\u5e30\u8ab2\u984c \u30c7\u30fc\u30bf2\n```\n\n### **\u2462 \u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u304c\u63d0\u4f9b\u3059\u308b\u30d5\u30a1\u30a4\u30eb\u4e00\u89a7\u306e\u53d6\u5f97**\n**\u3053\u3061\u3089\u306e\u6a5f\u80fd\u3092\u3054\u5229\u7528\u306e\u5834\u5408\u3001\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u53c2\u52a0\u306b\u540c\u610f\u3044\u305f\u3060\u304f\u5fc5\u8981\u304c\u3054\u3056\u3044\u307e\u3059(\u540c\u610f\u524d\u306e\u5834\u5408)\u3002**\n\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u53c2\u52a0\u306f\u30d6\u30e9\u30a6\u30b6\u304b\u3089\u5b9f\u884c\u3057\u3066\u304f\u3060\u3055\u3044\u3002\n\n```\n$ signate file-list --task_key=<task-key>\n```\n\n\u8ab2\u984c\u306e\u30d5\u30a1\u30a4\u30eb\u4e00\u89a7\u3092\u8868\u793a\u3057\u307e\u3059\u3002\n\n``` bash\n$ signate file-list --task_key=<task-key>\n\npublic_key file_name title file_size\n-------------------------------- --------------------- --------------------- -----------\nsa9bc5b1f9ef45f6b79bdbeb281895f3 sample1.zip \u5b66\u7fd2\u7528\u753b\u50cf\u30c7\u30fc\u30bf 60.65 MB\ng5609de723b148fe8635754dcd1706fa test_images.zip \u8a55\u4fa1\u7528\u753b\u50cf\u30c7\u30fc\u30bf 26.49 MB\n```\n\n### **\u2463 \u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u304c\u63d0\u4f9b\u3059\u308b\u30d5\u30a1\u30a4\u30eb\u306e\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9**\n**\u3053\u3061\u3089\u306e\u6a5f\u80fd\u3092\u3054\u5229\u7528\u306e\u5834\u5408\u3001\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u53c2\u52a0\u306b\u540c\u610f\u3044\u305f\u3060\u304f\u5fc5\u8981\u304c\u3054\u3056\u3044\u307e\u3059(\u540c\u610f\u524d\u306e\u5834\u5408)\u3002**\n\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u53c2\u52a0\u306f\u30d6\u30e9\u30a6\u30b6\u304b\u3089\u5b9f\u884c\u3057\u3066\u304f\u3060\u3055\u3044\u3002\n\n```\n$ signate download --task_key=<task-key> --file_key=<file-key> [--path=<path>]\n```\n\n\u30d5\u30a1\u30a4\u30eb\u3092\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u3057\u307e\u3059\u3002\n\u30c7\u30d5\u30a9\u30eb\u30c8\u3067\u306f\u30ab\u30ec\u30f3\u30c8\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306b\u30d5\u30a1\u30a4\u30eb\u304c\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u3055\u308c\u307e\u3059\u3002\n`--path=`\u3092\u6307\u5b9a\u3059\u308b\u3068\u3001\u30c0\u30a6\u30f3\u30ed\u30fc\u30c9\u5148\u306e\u30d1\u30b9\u3092\u6307\u5b9a\u3067\u304d\u307e\u3059\u3002\n\n``` bash\n$ signate download --task_key=<task-key> --file_key=<file-key> --path=/tmp/test.zip\n```\n\n### **\u2464 \u6295\u7a3f\u306e\u5b9f\u65bd**\n**\u3053\u3061\u3089\u306e\u6a5f\u80fd\u3092\u3054\u5229\u7528\u306e\u5834\u5408\u3001\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u53c2\u52a0\u306b\u540c\u610f\u3044\u305f\u3060\u304f\u5fc5\u8981\u304c\u3054\u3056\u3044\u307e\u3059(\u540c\u610f\u524d\u306e\u5834\u5408)\u3002**\n\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u53c2\u52a0\u306f\u30d6\u30e9\u30a6\u30b6\u304b\u3089\u5b9f\u884c\u3057\u3066\u304f\u3060\u3055\u3044\u3002\n\n```\n$ signate submit --task_key=<task-key> <\u7d50\u679c\u30d5\u30a1\u30a4\u30eb\u306e\u30d1\u30b9> --memo \u201ccomment\u201d\n```\n\n\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u306b\u6295\u7a3f\u3092\u5b9f\u65bd\u3057\u307e\u3059\u3002\n\n``` bash\n$ signate submit --task_key=<task-key> ~/test.zip --memo \"xxx\"\n\nSubmission completed successfully.\n```\n\n### **\u88dc\u8db3**\n#### \u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u3078\u306e\u540c\u610f\n\u4ee5\u4e0b\u306e\u3088\u3046\u306a\u30e1\u30c3\u30bb\u30fc\u30b8\u304c\u51fa\u529b\u3055\u308c\u305f\u969b\u306f\n```\nIf you haven\u2019t joined the competition yet, please do so through your browser.\n```\n\u30d6\u30e9\u30a6\u30b6\u306b\u3066\u8a72\u5f53\u30b3\u30f3\u30da\u30c6\u30a3\u30b7\u30e7\u30f3\u306b\u53c2\u52a0\u3092\u304a\u9858\u3044\u3044\u305f\u3057\u307e\u3059\u3002\n\n# **\u30e9\u30a4\u30bb\u30f3\u30b9**\nSIGNATE CLI\u306f[Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). \u3092\u9069\u7528\u3057\u3066\u304a\u308a\u307e\u3059\u3002\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "SIGNATE CLI",
"version": "0.10.4",
"project_urls": {
"Homepage": "https://user.competition.signate.jp"
},
"split_keywords": [
"signate",
" signate-cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "835a88640db50ce3954b040fd5b33728efb692a02a90aadb0224872bdd520bd1",
"md5": "ddeeb98eb694952d3194d8eb854c950d",
"sha256": "f0b3c35f96fe1842cf381ce30ef364f1ac0e1afba15fa89c6467d93ab0910793"
},
"downloads": -1,
"filename": "signate-0.10.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ddeeb98eb694952d3194d8eb854c950d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 7550,
"upload_time": "2025-07-25T08:51:28",
"upload_time_iso_8601": "2025-07-25T08:51:28.415337Z",
"url": "https://files.pythonhosted.org/packages/83/5a/88640db50ce3954b040fd5b33728efb692a02a90aadb0224872bdd520bd1/signate-0.10.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "13c6da439706a02bc916c82edf190904d461349c4f5c31ceb1efc2aaf240e644",
"md5": "ed55b5ebbc0563bb0583baa42a673325",
"sha256": "7768a9d158880ed3b78656d58027d1fed4591041e19d8c33a7123a44b5161906"
},
"downloads": -1,
"filename": "signate-0.10.4.tar.gz",
"has_sig": false,
"md5_digest": "ed55b5ebbc0563bb0583baa42a673325",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 8812,
"upload_time": "2025-07-25T08:51:29",
"upload_time_iso_8601": "2025-07-25T08:51:29.677439Z",
"url": "https://files.pythonhosted.org/packages/13/c6/da439706a02bc916c82edf190904d461349c4f5c31ceb1efc2aaf240e644/signate-0.10.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-25 08:51:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "signate"
}
JSON