ユーザーマニュアル

パーソナルアクセストークンとプロジェクトの「GUID」を利用して、コマンドラインによる​GakuNin RDMの操作が可能です。
コマンドラインツールのPythonコードは、GitHubで公開しています。
​・https://github.com/RCOSDP/rdmclient​

可能な操作

• プロジェクト中のファイル一覧取得
• ファイルのアップロード/ダウンロード
• ファイルの移動/削除
• ディレクトリの作成

rdmclientのインストール方法 (汎用)​

1. GitHubのリポジトリ rdmclientのmasterブランチをgit clone​

https://github.com/RCOSDP/rdmclient​

2. Pythonの仮想実行環境 pyenv をインストールして、activateする。
1. % pyenv virtualenv ＜Pythonバージョン＞ ＜Python仮想環境名＞​
2. % pyenv activate ＜Pyton仮想環境名＞
3. rdmclient ファイルのディレクト中で必要なPythonパッケージをpipでインストール。
1. % pip install -r requirements.txt
4. rdmclient ファイルのディレクト中でpipを使ってインストール​
1. % cd ./rdmclient​​
2. % pip install .
5. インストールの確認​
1. % osf -v

osf 0.0.4​



6. GRDMのユーザ設定画面でパーソナルアクセストークンを払い出して、環境変数OSF_TOKENへ設定。​
1. % export OSF_TOKEN=＜GRDMパーソナルアクセストークン＞

rdmclientの基本コマンド​

• GRDMのプロジェクト中のファイル一覧を取得
​ % osf --base-url https://api.rdm.nii.ac.jp/v2/ -p ＜プロジェクト名＞ ls(または"osf list")​


• GRDMのプロジェクトへファイルをアップロード​
% osf --base-url https://api.rdm.nii.ac.jp/v2/ -p <プロジェクト名> upload <ローカルの転送元のファイル名> ​
＊-r を指定することで、カレントディレクトリ中のファイルの再帰的なアップロードが可能です。​


• GRDMのプロジェクトへディレクトリを作成​
% osf --base-url https://api.rdm.nii.ac.jp/v2/ -p <プロジェクト名> mkdir(または"makefolder") <作成するディレクトリのパス/ディレクトリ名>


• GRDM上のプロジェクト中のファイルの取得​
% osf --base-url https://api.rdm.nii.ac.jp/v2/ -p <プロジェクト名> fetch <ローカルの保存先>


• GRDM上のプロジェクト中の全ファイルの取得​
% osf --base-url https://api.rdm.nii.ac.jp/v2/ -p <プロジェクト名> clone <ローカルの保存先のパス/ディレクトリ>


• GRDM上のプロジェクト中のファイルの移動​
% osf --base-url https://api.rdm.nii.ac.jp/v2/ -p <プロジェクト名> mv(または"move")


• GRDM上のプロジェクト中のファイルの削除​
% osf --base-url https://api.rdm.nii.ac.jp/v2/ -p <プロジェクト名> rm(または"remove")





利用上の注意点

• 操作対象となるストレージは、osfコマンドによって異なります。プロジェクト内のファイル一覧表示（ls）や、プロジェクト自体のダウンロード（clone）では、拡張ストレージも対象となります。
  fetch, upload, rm, mv は、拡張ストレージには対応していません。
• osf コマンドは、実施毎にプロジェクト内のすべてのファイルパス・ファイル名を抽出した上で指定された処理を実施する構造のため、多くのファイルが存在するプロジェクトや、階層の深いフォルダを持つプロジェクトを指定すると、コマンド実行に時間がかかる場合があります。