annoworkcli


Nameannoworkcli JSON
Version 3.1.2 PyPI version JSON
download
home_pagehttps://github.com/kurusugawa-computer/annowork-cli
Summary
upload_time2022-06-22 04:49:08
maintainer
docs_urlNone
authoryuji38kwmt
requires_python>=3.8,<4.0
licenseMIT
keywords annowork cli
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            
# 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,

```








# VSCode Devcontainerを使って開発する方法
1. 以下の環境変数を定義します。
    * `ANNOFAB_USER_ID`
    * `ANNOFAB_PASSWORD`
    * `ANNOWORK_USER_ID`
    * `ANNOWORK_PASSWORD`

2. VSCodeのdevcontainerを起動します。




            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kurusugawa-computer/annowork-cli",
    "name": "annoworkcli",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8,<4.0",
    "maintainer_email": "",
    "keywords": "annowork,cli",
    "author": "yuji38kwmt",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c4/45/75b660da3e248260d4427b12fc1650792cfd0d384e69d576f2a861e28ed5/annoworkcli-3.1.2.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\n# VSCode Devcontainer\u3092\u4f7f\u3063\u3066\u958b\u767a\u3059\u308b\u65b9\u6cd5\n1. \u4ee5\u4e0b\u306e\u74b0\u5883\u5909\u6570\u3092\u5b9a\u7fa9\u3057\u307e\u3059\u3002\n    * `ANNOFAB_USER_ID`\n    * `ANNOFAB_PASSWORD`\n    * `ANNOWORK_USER_ID`\n    * `ANNOWORK_PASSWORD`\n\n2. VSCode\u306edevcontainer\u3092\u8d77\u52d5\u3057\u307e\u3059\u3002\n\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "",
    "version": "3.1.2",
    "split_keywords": [
        "annowork",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "5c6594ecff8bc82dc199d9c9329ea350",
                "sha256": "ce1840d1f112cbbfa0950f566d9939a8875be3e3cd87afb275f703e07ef89ed5"
            },
            "downloads": -1,
            "filename": "annoworkcli-3.1.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "5c6594ecff8bc82dc199d9c9329ea350",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8,<4.0",
            "size": 97752,
            "upload_time": "2022-06-22T04:49:05",
            "upload_time_iso_8601": "2022-06-22T04:49:05.542472Z",
            "url": "https://files.pythonhosted.org/packages/f1/14/14c5a01790e5b176f550fb6f09b2b41c72235be724539a44e36cff8bdc18/annoworkcli-3.1.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4ee400f6c2aabdabbe938bcdf91fc63e",
                "sha256": "f770badccdeb26c9e00491870aaf469da0fd3d917db9c011672a7b57dba56a8d"
            },
            "downloads": -1,
            "filename": "annoworkcli-3.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "4ee400f6c2aabdabbe938bcdf91fc63e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8,<4.0",
            "size": 51932,
            "upload_time": "2022-06-22T04:49:08",
            "upload_time_iso_8601": "2022-06-22T04:49:08.148570Z",
            "url": "https://files.pythonhosted.org/packages/c4/45/75b660da3e248260d4427b12fc1650792cfd0d384e69d576f2a861e28ed5/annoworkcli-3.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-06-22 04:49:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "kurusugawa-computer",
    "github_project": "annowork-cli",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "lcname": "annoworkcli"
}
        
Elapsed time: 0.43931s