# annowork-cli
AnnoworkのCLIです。
[![Build Status](https://app.travis-ci.com/kurusugawa-computer/annowork-cli.svg?branch=main)](https://app.travis-ci.com/kurusugawa-computer/annowork-cli)
[![CodeQL](https://github.com/kurusugawa-computer/annowork-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/kurusugawa-computer/annowork-cli/actions/workflows/codeql-analysis.yml)
[![PyPI version](https://badge.fury.io/py/annoworkcli.svg)](https://badge.fury.io/py/annoworkcli)
[![Python Versions](https://img.shields.io/pypi/pyversions/annoworkcli.svg)](https://pypi.org/project/annoworkcli/)
[![Documentation Status](https://readthedocs.org/projects/annowork-cli/badge/?version=latest)](https://annowork-cli.readthedocs.io/ja/latest/?badge=latest)
# Requirements
* Python3.8+
# Install
```
$ pip install annoworkcli
```
# Usage
## 認証情報の設定
### `.netrc`
`$HOME/.netrc`ファイルに以下を記載する。
```
machine annowork.com
login annowork_user_id
password annowork_password
```
### 環境変数
* 環境変数`ANNOWORK_USER_ID` , `ANNOWORK_PASSWORD`
### `annoworkcli annofab`コマンドを利用する場合
`annoworkcli annofab`コマンドはannofabのwebapiにアクセスするため、annofabのwebapiの認証情報を指定する必要があります。
* 環境変数`ANNOFAB_USER_ID` , `ANNOFAB_PASSWORD`
* `$HOME/.netrc`ファイル
```
machine annofab.com
login annofab_user_id
password annofab_password
```
## コマンドの使い方
```
# CSV出力
$ annoworkcli actual_working_time list_daily --workspace_id foo \
--start_date 2022-05-01 --end_date 2022-05-10 --output out.csv
$ cat out.csv
date,job_id,job_name,workspace_member_id,user_id,username,actual_working_hours,notes
2022-05-02,5c39a2e8-90dd-4f20-b0a6-39d7f5129e3d,MOON,52ff73fb-c1d6-4ad6-a185-64386ee7169f,alice,Alice,11.233333333333334,
2022-05-02,5c39a2e8-90dd-4f20-b0a6-39d7f5129e3d,MARS,c66acd58-c893-4908-bdcc-1414978bf06b,bob,Bob,8.0,
```
# 開発者向けの情報
https://github.com/kurusugawa-computer/annowork-cli/blob/main/README_for_developer.md
Raw data
{
"_id": null,
"home_page": "https://github.com/kurusugawa-computer/annowork-cli",
"name": "annoworkcli",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "annowork, cli",
"author": "Kurusugawa Computer Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/46/d3/024f535bf272ffedf33bab95b9e36ad78ce11738ac5a82cc77aa2fc6d1f3/annoworkcli-3.7.1.tar.gz",
"platform": null,
"description": "\n# annowork-cli\nAnnowork\u306eCLI\u3067\u3059\u3002\n\n\n[![Build Status](https://app.travis-ci.com/kurusugawa-computer/annowork-cli.svg?branch=main)](https://app.travis-ci.com/kurusugawa-computer/annowork-cli)\n[![CodeQL](https://github.com/kurusugawa-computer/annowork-cli/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/kurusugawa-computer/annowork-cli/actions/workflows/codeql-analysis.yml)\n[![PyPI version](https://badge.fury.io/py/annoworkcli.svg)](https://badge.fury.io/py/annoworkcli)\n[![Python Versions](https://img.shields.io/pypi/pyversions/annoworkcli.svg)](https://pypi.org/project/annoworkcli/)\n[![Documentation Status](https://readthedocs.org/projects/annowork-cli/badge/?version=latest)](https://annowork-cli.readthedocs.io/ja/latest/?badge=latest)\n\n\n# Requirements\n* Python3.8+\n\n\n# Install\n```\n$ pip install annoworkcli\n```\n\n\n# Usage\n\n\n## \u8a8d\u8a3c\u60c5\u5831\u306e\u8a2d\u5b9a\n\n### `.netrc`\n\n`$HOME/.netrc`\u30d5\u30a1\u30a4\u30eb\u306b\u4ee5\u4e0b\u3092\u8a18\u8f09\u3059\u308b\u3002\n\n```\nmachine annowork.com\nlogin annowork_user_id\npassword annowork_password\n```\n\n\n### \u74b0\u5883\u5909\u6570\n* \u74b0\u5883\u5909\u6570`ANNOWORK_USER_ID` , `ANNOWORK_PASSWORD`\n\n### `annoworkcli annofab`\u30b3\u30de\u30f3\u30c9\u3092\u5229\u7528\u3059\u308b\u5834\u5408\n`annoworkcli annofab`\u30b3\u30de\u30f3\u30c9\u306fannofab\u306ewebapi\u306b\u30a2\u30af\u30bb\u30b9\u3059\u308b\u305f\u3081\u3001annofab\u306ewebapi\u306e\u8a8d\u8a3c\u60c5\u5831\u3092\u6307\u5b9a\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002\n* \u74b0\u5883\u5909\u6570`ANNOFAB_USER_ID` , `ANNOFAB_PASSWORD`\n* `$HOME/.netrc`\u30d5\u30a1\u30a4\u30eb\n\n```\nmachine annofab.com\nlogin annofab_user_id\npassword annofab_password\n```\n\n\n\n\n## \u30b3\u30de\u30f3\u30c9\u306e\u4f7f\u3044\u65b9\n\n\n```\n# CSV\u51fa\u529b\n$ annoworkcli actual_working_time list_daily --workspace_id foo \\\n --start_date 2022-05-01 --end_date 2022-05-10 --output out.csv\n\n$ cat out.csv\ndate,job_id,job_name,workspace_member_id,user_id,username,actual_working_hours,notes\n2022-05-02,5c39a2e8-90dd-4f20-b0a6-39d7f5129e3d,MOON,52ff73fb-c1d6-4ad6-a185-64386ee7169f,alice,Alice,11.233333333333334,\n2022-05-02,5c39a2e8-90dd-4f20-b0a6-39d7f5129e3d,MARS,c66acd58-c893-4908-bdcc-1414978bf06b,bob,Bob,8.0,\n\n```\n\n\n\n\n\n\n\n# \u958b\u767a\u8005\u5411\u3051\u306e\u60c5\u5831\nhttps://github.com/kurusugawa-computer/annowork-cli/blob/main/README_for_developer.md",
"bugtrack_url": null,
"license": "MIT",
"summary": "Annowork\u306eCLI(Command Line Interface)",
"version": "3.7.1",
"project_urls": {
"Homepage": "https://github.com/kurusugawa-computer/annowork-cli",
"Repository": "https://github.com/kurusugawa-computer/annowork-cli"
},
"split_keywords": [
"annowork",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed1fd1f8c192d86eaad55979655976ab13c063a2c80758c6e7b6763bef7c7382",
"md5": "c28ed14c20ca1c2eba1ed345baa1444a",
"sha256": "bbde3774db61a7e04bca7b3691832a202a3fb9496befa570f9a45072bff1e24e"
},
"downloads": -1,
"filename": "annoworkcli-3.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c28ed14c20ca1c2eba1ed345baa1444a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 105328,
"upload_time": "2024-04-24T03:16:01",
"upload_time_iso_8601": "2024-04-24T03:16:01.632184Z",
"url": "https://files.pythonhosted.org/packages/ed/1f/d1f8c192d86eaad55979655976ab13c063a2c80758c6e7b6763bef7c7382/annoworkcli-3.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "46d3024f535bf272ffedf33bab95b9e36ad78ce11738ac5a82cc77aa2fc6d1f3",
"md5": "72ff879d26340a541412a277fead370f",
"sha256": "166fc25bae83d01cda4fa490fe9d3217ff175274ab2d31c38f67c11c2aa064c9"
},
"downloads": -1,
"filename": "annoworkcli-3.7.1.tar.gz",
"has_sig": false,
"md5_digest": "72ff879d26340a541412a277fead370f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 56933,
"upload_time": "2024-04-24T03:16:03",
"upload_time_iso_8601": "2024-04-24T03:16:03.803508Z",
"url": "https://files.pythonhosted.org/packages/46/d3/024f535bf272ffedf33bab95b9e36ad78ce11738ac5a82cc77aa2fc6d1f3/annoworkcli-3.7.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 03:16:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kurusugawa-computer",
"github_project": "annowork-cli",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "annoworkcli"
}