Package: signate
SIGNATE CLISIGNATEの公式APIコマンドラインインターフェイス(以下：SIGNATE CLI)です。SIGNATEはData Science Competitionのご提供を始めとした、データサイエンティストの皆様のための統合プラットフォームです。※SIGNATE CLIの動作にはPython3.6 以降の環境が必要です。※当CLIはβ版であり、予告なく変更させていただく可能性がございます。予めご了承ください。※SIGNATE CLIはMac OSおよびLinuxをサポートしております。インストールと事前準備以下のコマンドでインストールをお願いいたします。$ pip install signateインストール後、以下の手順を実施ください。SIGNATEでアカウント登録アカウント登録後、アカウント設定画面の "API Token" の "作成" をクリック"新規作成" をクリックしてAPI Token(signate.json)を取得~/.signateを作成＊ ~/ はホームディレクトリを指します。ホームディレクトリ直下に .signate を作成してください。＊ . から始まるフォルダは隠しフォルダです。隠しフォルダを表示した状態でご確認ください。取得したAPI Tokenを~/.signate直下に配置＊ SIGNATE CLI 上でも API Token は取得できます。詳しくは「利用方法」⑤をご参照ください。＊ SNS で会員登録した場合はアカウント設定画面でのみ API Token を取得可能です。以下のコマンドでヘルプが表示されましたら利用準備完了です。$ signate --helpsignate: command not foundと表示される場合、環境変数$PATH のディレクトリ内にsignateが存在していることをご確認ください。pip uninstall signateコマンドでsignateコマンドがインストールされているディレクトリの確認signateコマンドのアンインストールが可能です。利用方法SIGNATE CLIでは以下の機能が利用できます。$signate--help
Usage:signate[OPTIONS]COMMAND[ARGS]...

Options:--helpShowthismessageandexit.

Commands:downloadDownloadthefileofcompetitionfilesListfileofcompetitionlistListcompetitionsubmitSubmitaresultfiletothecompetitiontokenDownloadtheAPIToken① 投稿可能なコンペティション一覧の取得$ signate list投稿可能なコンペティション一覧を表示します。$signatelistcompetitionIdtitleclosingprizeparticipants
-----------------------------------------------------------------------1a-ai-competition-$200,001002b-ai-competition2019-12-31Knowledge50……② コンペティションが提供するファイル一覧の取得$ signate files --competition-id=<competition-id>コンペティションが提供するファイルの一覧を表示します。$signatefiles--competition-id=1fileIdnametitlesizeupdated_at
-----------------------------------------------------------------1train.csv学習用データ23450672016-05-3111:19:482test.csv検証用データ1523536……③ コンペティションが提供するファイルのダウンロードこちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。詳しくは補足 コンペティションへの同意をご確認ください。$ signate download --competition-id=<competition-id>コンペティションが提供するファイルをダウンロードします。
デフォルトの場合カレントディレクトリにファイルがダウンロードされます。competition-idのみを指定した場合、該当コンペティションが提供するすべてのファイルがダウンロード対象となります。$signatedownload--competition-id=1submit_sample.csv100%[.................................................................]205890/205890test.csv100%[.................................................................]1523536/1523536train.csv100%[.................................................................]2345067/2345067Downloadcompleted.以下のようにご指定いただくことで、ダウンロードするファイルの指定とダウンロード先のパス指定もそれぞれ可能です。$signatedownload--competition-id=1--file-id=1--path=/Users/[user_name]/Desktop/
train.csv100%[.................................................................]2345067/2345067Downloadcompleted.④ データセットの提出こちらの機能をご利用の場合、コンペティションへの参加に同意いただく必要がございます(同意前の場合)。詳しくは補足 コンペティションへの同意をご確認ください。signatesubmit--competition-id=<competition-id><結果ファイルのパス>コンペティションにデータセットを提出します。$signatesubmit--competition-id=1/Users/[user_name]/Desktop/result.csv
Youhavesuccessfullysubmittedyourpredictions.Wewillsendyouthesubmissionresulttoyouremailaddress.コメントを残すことも可能です。$signatesubmit--competition-id=1/Users/[user_name]/Desktop/result.csv--note頑張りました
Youhavesuccessfullysubmittedyourpredictions.Wewillsendyouthesubmissionresulttoyouremailaddress.⑤ APITokenの取得APIトークン取得コマンドを実行し、APIでアクセスに必要なトークンを取得します。$signatetoken--email=事前準備で登録したemail--password=事前準備で登録したパスワード
TheApiTokensuccessfullydownloaded.補足コンペティションへの同意以下のようなメッセージが出力された際はYou have not accepted the competition terms of use!

Do you accept the competition terms of use?
Please read the terms of use before accepting: https://signate.jp/competitions/*#terms
 [y/N]:リンク先をご一読いただき、yのご入力をお願いいたします。以降、同一コンペティションで当メッセージは表示されません。プロフィール入力の不足You have not filled in user infomation to join the competition. Go to https://signate.jp/profile.のメッセージが表示された場合はSIGNATEにアクセスいただき、プロフィールのご入力をお願いいたします。ライセンスSIGNATE CLIはApache 2.0 license. を適用しております。