readmeの追加

Author: yuji38kwmt

Makefile

@@ -5,8 +5,8 @@ init:
 	pipenv install --dev
 
 format:
-	pipenv run isort --verbose --recursive annofabapi tests
-	pipenv run yapf --verbose --in-place --recursive annofabapi tests
+	pipenv run isort --verbose --recursive annofabapi tests examples
+	pipenv run yapf --verbose --in-place --recursive annofabapi tests examples
 
 lint:
 	pipenv run flake8 annofabapi tests

README.md

@@ -1,5 +1,5 @@
 # annofab-api-python-client
-AnnoFab Web API(https://annofab.com/docs/api/)のPythonクライアントライブラリです。
+[AnnoFab Web API](https://annofab.com/docs/api/)のPythonクライアントライブラリです。
 
 
 # 注意
@@ -27,6 +27,8 @@ $ pip install annofabapi
 
 ## インスタンス生成
 
+### user_id, passwordをコンストラクタ引数に渡す
+
 ```python
 # APIアクセス用のインスタンスを生成
 from annofabapi import build
@@ -38,6 +40,31 @@ password = "YYYYYY"
 service = build(user_id, password)
 ```
 
+### `.netrc`に記載されたuser_id, passwordから生成
+`.netrc`ファイルに、AnnofabのユーザIDとパスワードを記載する。
+
+```plain:.netrc
+machine annofab.com
+login annofab_user_id
+password annofab_password
+```
+
+```python
+from annofabapi import build_from_netrc
+service = build_from_netrc()
+```
+
+
+#### For Linux
+* パスは`$HOME/.netrc`
+* `$ chmod 600 $HOME/.netrc`でパーミッションを変更する
+
+
+
+#### For Windows
+* パスは`%USERPROFILE%\.netrc`
+
+
 ## `service.api`のサンプルコード
 
 * `service.api`には、Web APIに対応するメソッドが定義されています。
@@ -101,4 +128,4 @@ TODO
 
 
 ## Usage for Develper
-[](README_for_developer.md)を参照してください。
+[README_for_developer.md](README_for_developer.md)を参照してください。

README_for_developer.md

@@ -18,19 +18,19 @@ $ make init
 詳細は[generate/README.md](generate/README_for_generate.md)を参照してください。
 
 ## テスト実行方法
-TODO
+1. AnnoFabの認証情報を`.netrc`に記載する。
+2. `pytest.ini`にテスト対象の`project_id`を指定. テスト実行により、プロジェクトが変更されることに注意！！
+3. `$ make test`コマンドを実行する。
 
-### 準備
-1. pytest.iniにテスト対象のproject_idを指定. **プロジェクトが変更される恐れがあることに注意！！**
-2. 以下の環境変数にAnnofabの認証情報を設定
-    * `ANNOFAB_USER_ID`
-    * `ANNOFAB_PASSWORD`
-3. `pipenv run tox` でテスト実行
+### テストの考え方
+#### 確認すること
+* get系のメソッドはワンパスが通ること
+* 「タスクの作成」など、よく使うメソッドで、簡単に実行や確認ができるメソッドのワンパスが通ること
 
-### 備考
-* 基本的に、テストメソッドは、エラーが発生しないこと（HTTP STatus codeが400系でないこと）を確認しています。それより詳細な確認は行っていません。
+#### 確認しないこと
+* 「組織の削除」、「プロジェクトの削除」など間違って操作してしまったときの影響が多いメソッド
+* 「パスワード変更」など使用頻度が少なく、実行や確認がしづらいメソッド
 
-    
 
 ## フォーマッターを実行