https://github.com/kurusugawa-computer/annowork-api-python-client

annowork webapiのpython用クライアントライブラリです。
https://github.com/kurusugawa-computer/annowork-api-python-client

annowork

Last synced: about 2 months ago
JSON representation

annowork webapiのpython用クライアントライブラリです。

• Host: GitHub
• URL: https://github.com/kurusugawa-computer/annowork-api-python-client
• Owner: kurusugawa-computer
• License: mit
• Created: 2022-01-11T08:49:51.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-01T11:09:41.000Z (4 months ago)
• Last Synced: 2024-10-29T05:38:39.854Z (3 months ago)
• Topics: annowork
• Language: Python
• Homepage: https://annowork-api-python-client.readthedocs.io/ja/latest/
• Size: 493 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# annowork-api-python-client

Annowork WebAPIのPython用クライントライブラリです。

[![Build Status](https://app.travis-ci.com/kurusugawa-computer/annowork-api-python-client.svg?branch=main)](https://app.travis-ci.com/kurusugawa-computer/annowork-api-python-client)

[![PyPI version](https://badge.fury.io/py/annoworkapi.svg)](https://badge.fury.io/py/annoworkapi)

[![Python Versions](https://img.shields.io/pypi/pyversions/annoworkapi.svg)](https://pypi.org/project/annoworkapi/)

[![Documentation Status](https://readthedocs.org/projects/annowork-api-python-client/badge/?version=latest)](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) 参照