# 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.9+
# 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`または`ANNOFAB_PAT`
## コマンドの使い方
```
# 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/da/1c/b995c232374e3a315bb57d31f775fbf29795f0d206bf7ddba1e5ff21553c/annoworkcli-3.8.3.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.9+\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`\u307e\u305f\u306f`ANNOFAB_PAT`\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.8.3",
"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": "6ff883418ec3362f9c1ee862665d2c61daf05316f7bff68de80c674311142c37",
"md5": "6f33604c9ce3720a9c855ec22e036e6a",
"sha256": "cfa68098912b14b329b935c93cce5e78f9af5c9cd393cb00d62a299eaf6a9c5e"
},
"downloads": -1,
"filename": "annoworkcli-3.8.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6f33604c9ce3720a9c855ec22e036e6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 105742,
"upload_time": "2024-10-02T15:09:18",
"upload_time_iso_8601": "2024-10-02T15:09:18.381061Z",
"url": "https://files.pythonhosted.org/packages/6f/f8/83418ec3362f9c1ee862665d2c61daf05316f7bff68de80c674311142c37/annoworkcli-3.8.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "da1cb995c232374e3a315bb57d31f775fbf29795f0d206bf7ddba1e5ff21553c",
"md5": "ada49863b4f5937bc84d0f28cd33c9cd",
"sha256": "3754121071b48f749d79d37350fe8e1e9909ac381ac156866c6aebe2a5e15dfc"
},
"downloads": -1,
"filename": "annoworkcli-3.8.3.tar.gz",
"has_sig": false,
"md5_digest": "ada49863b4f5937bc84d0f28cd33c9cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 56897,
"upload_time": "2024-10-02T15:09:21",
"upload_time_iso_8601": "2024-10-02T15:09:21.538338Z",
"url": "https://files.pythonhosted.org/packages/da/1c/b995c232374e3a315bb57d31f775fbf29795f0d206bf7ddba1e5ff21553c/annoworkcli-3.8.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 15:09:21",
"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"
}