# annowork-api-python-client
Annowork WebAPIのPython用クライントライブラリです。
[](https://app.travis-ci.com/kurusugawa-computer/annowork-api-python-client)
[](https://badge.fury.io/py/annoworkapi)
[](https://pypi.org/project/annoworkapi/)
[](https://annowork-api-python-client.readthedocs.io/ja/latest/?badge=latest)
# Requirements
* Python 3.8+
# Install
```
$ pip install annoworkapi
```
# Usage
## 認証情報の設定方法
### `$HOME/.netrc`
```
machine annowork.com
login ${user_id}
password ${password}
```
### 環境変数に設定する場合
環境変数`ANNOWORK_USER_ID`にユーザID, `ANNOWORK_PASSWORD` にパスワードを設定する。
## 基本的な使い方
```python
import annoworkapi
service = annoworkapi.build()
result = service.api.get_my_account()
print(result)
# {'account_id': 'xxx', ... }
```
## 応用的な使い方
### ログの出力
```python
import logging
logging_formatter = '%(levelname)-8s : %(asctime)s : %(name)s : %(message)s'
logging.basicConfig(format=logging_formatter)
logging.getLogger("annoworkapi").setLevel(level=logging.DEBUG)
```
```
In [1]: c = s.api.get_actual_working_times_by_workspacen_member("a9956d30-b201-418a-a03b-b9b8b55b2e3d", "204bf4d9-4569-4b7b-89b9-84f089201247")
DEBUG : 2022-01-11 17:36:04,354 : api.py : annoworkapi.api : _request_wrapper : Sent a request :: {'request': {'http_method': 'get', 'url': 'https://annowork.com/api/v1/workspacens/a9956d30-b201-418a-a03b-b9b8b55b2e3d/members/204bf4d9-4569-4b7b-89b9-84f089201247/actual-working-times', 'query_params': None, 'header_params': None, 'request_body': None}, 'response': {'status_code': 200, 'content_length': 209988}}
```
# 開発者用ドキュメント
[README_for_developer.md](https://github.com/kurusugawa-computer/annowork-api-python-client/blob/main/README_for_developer.md) 参照
Raw data
{
"_id": null,
"home_page": "https://github.com/kurusugawa-computer/annowork-api-python-client",
"name": "annoworkapi",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "annowork,api",
"author": "yuji38kwmt",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/74/b8/81190f5ec1ef8b5139b4b8b518d3cec487221e3c7fbeb6bafbaadd7e512b/annoworkapi-3.2.1.tar.gz",
"platform": null,
"description": "# annowork-api-python-client\nAnnowork WebAPI\u306ePython\u7528\u30af\u30e9\u30a4\u30f3\u30c8\u30e9\u30a4\u30d6\u30e9\u30ea\u3067\u3059\u3002\n\n[](https://app.travis-ci.com/kurusugawa-computer/annowork-api-python-client)\n[](https://badge.fury.io/py/annoworkapi)\n[](https://pypi.org/project/annoworkapi/)\n[](https://annowork-api-python-client.readthedocs.io/ja/latest/?badge=latest)\n\n\n\n# Requirements\n* Python 3.8+ \n\n# Install\n\n```\n$ pip install annoworkapi\n```\n\n# Usage\n\n## \u8a8d\u8a3c\u60c5\u5831\u306e\u8a2d\u5b9a\u65b9\u6cd5\n\n### `$HOME/.netrc`\n\n```\nmachine annowork.com\nlogin ${user_id}\npassword ${password}\n```\n\n### \u74b0\u5883\u5909\u6570\u306b\u8a2d\u5b9a\u3059\u308b\u5834\u5408\n\u74b0\u5883\u5909\u6570`ANNOWORK_USER_ID`\u306b\u30e6\u30fc\u30b6ID, `ANNOWORK_PASSWORD` \u306b\u30d1\u30b9\u30ef\u30fc\u30c9\u3092\u8a2d\u5b9a\u3059\u308b\u3002\n\n\n\n## \u57fa\u672c\u7684\u306a\u4f7f\u3044\u65b9\n\n```python\nimport annoworkapi\nservice = annoworkapi.build()\n\nresult = service.api.get_my_account()\nprint(result)\n# {'account_id': 'xxx', ... }\n```\n\n\n## \u5fdc\u7528\u7684\u306a\u4f7f\u3044\u65b9\n\n### \u30ed\u30b0\u306e\u51fa\u529b\n\n```python\nimport logging\nlogging_formatter = '%(levelname)-8s : %(asctime)s : %(name)s : %(message)s'\nlogging.basicConfig(format=logging_formatter)\nlogging.getLogger(\"annoworkapi\").setLevel(level=logging.DEBUG)\n```\n\n\n```\nIn [1]: c = s.api.get_actual_working_times_by_workspacen_member(\"a9956d30-b201-418a-a03b-b9b8b55b2e3d\", \"204bf4d9-4569-4b7b-89b9-84f089201247\")\nDEBUG : 2022-01-11 17:36:04,354 : api.py : annoworkapi.api : _request_wrapper : Sent a request :: {'request': {'http_method': 'get', 'url': 'https://annowork.com/api/v1/workspacens/a9956d30-b201-418a-a03b-b9b8b55b2e3d/members/204bf4d9-4569-4b7b-89b9-84f089201247/actual-working-times', 'query_params': None, 'header_params': None, 'request_body': None}, 'response': {'status_code': 200, 'content_length': 209988}}\n```\n\n\n# \u958b\u767a\u8005\u7528\u30c9\u30ad\u30e5\u30e1\u30f3\u30c8\n[README_for_developer.md](https://github.com/kurusugawa-computer/annowork-api-python-client/blob/main/README_for_developer.md) \u53c2\u7167\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Clinet Library of Annowork WebAPI",
"version": "3.2.1",
"project_urls": {
"Homepage": "https://github.com/kurusugawa-computer/annowork-api-python-client",
"Repository": "https://github.com/kurusugawa-computer/annowork-api-python-client"
},
"split_keywords": [
"annowork",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca102db14796dbb487b85607b98a3135d8a74d0c4cfdd98423a727ad2e214f88",
"md5": "d6fc9687855e83932062ebf5dfdf2627",
"sha256": "fa3db300a0accd3d75918a181ff5f0bc530895b80d2c60831a02197bb303a05e"
},
"downloads": -1,
"filename": "annoworkapi-3.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d6fc9687855e83932062ebf5dfdf2627",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 22457,
"upload_time": "2024-03-01T05:44:35",
"upload_time_iso_8601": "2024-03-01T05:44:35.510084Z",
"url": "https://files.pythonhosted.org/packages/ca/10/2db14796dbb487b85607b98a3135d8a74d0c4cfdd98423a727ad2e214f88/annoworkapi-3.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "74b881190f5ec1ef8b5139b4b8b518d3cec487221e3c7fbeb6bafbaadd7e512b",
"md5": "1036ef9bbbe235670e1f324362224740",
"sha256": "f972c96648d9dd8dbfe58ed02ab255545a3e1bdefaddfe0ddd8b72fecd051355"
},
"downloads": -1,
"filename": "annoworkapi-3.2.1.tar.gz",
"has_sig": false,
"md5_digest": "1036ef9bbbe235670e1f324362224740",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 19020,
"upload_time": "2024-03-01T05:44:37",
"upload_time_iso_8601": "2024-03-01T05:44:37.615320Z",
"url": "https://files.pythonhosted.org/packages/74/b8/81190f5ec1ef8b5139b4b8b518d3cec487221e3c7fbeb6bafbaadd7e512b/annoworkapi-3.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-01 05:44:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kurusugawa-computer",
"github_project": "annowork-api-python-client",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "annoworkapi"
}
JSON
