Need to create a news fragment, explain the changes and make unit tests for the changes.

Implement client-side rate limiting according to official documentation.

Refs

• https://nordicapis.com/everything-you-need-to-know-about-api-rate-limiting/
• https://12bme.tistory.com/547 (korean)

Limit usage according to UX guidelines. it would be optional policy plugins to validate for block
Ref https://docs.kakaoi.ai/kakao_work/blockkit/uxguide/

Generate docs skeletons via Sphinx.
And create pages like flask, requests, etc.
Finally, create gh-pages, readthebooks or etc. automatically.

BlockKit API format changed (KakaoWork 1.7+)

• Text Block, Description Block, Section Block, Context Block

Removing duplicated test codes. See https://docs.pytest.org/en/6.2.x/parametrize.html

The action property can be one of Compatability or Exclusive

See more details https://docs.kakaoi.ai/kakao_work/blockkit/buttonblock/

Add docstrings for API. This can be used for automated documentation via Sphinx
Refer https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html#example-google

Set the coverage fail condition, etc.

An exception occurs when an undefined field is added to any model.

$ poetry run kakaowork -k $(cat ~/kakaoworkbot-appkey) users list
Traceback (most recent call last):
...
TypeError: __new__() got an unexpected keyword argument 'display_name'

See https://docs.kakaoi.ai/kakao_work/webapireference/messages/#messagessend_by

URLs without a file extension, such as short URLs, are treated as invalid and cannot be sent.

Examples

$ KAKAOWORK_APP_KEY=your_app_key kakaowork users list # or, kakaowork --app-key=your_app_key users list
1  name1  ...
2 name2 ...

$ KAKAOWORK_APP_KEY=your_app_key kakaowork users list -o json # or, kakaowork --app-key=your_app_key users list -o json
[
  {"id": 1, "name": "name1", ...},
  {"id": 2, "name": "name2", ...}
]

Perhaps it's because the dependency resolution didn't work properly...

https://readthedocs.org/projects/kakaowork-py/builds/14243283/

Running Sphinx v4.1.1

Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/kakaowork-py/envs/latest/lib/python3.7/site-packages/sphinx/config.py", line 327, in eval_config_file
    exec(code, namespace)
  File "/home/docs/checkouts/readthedocs.org/user_builds/kakaowork-py/checkouts/latest/docs/conf.py", line 18, in <module>
    from kakaowork import __version__  # noqa: E402
  File "/home/docs/checkouts/readthedocs.org/user_builds/kakaowork-py/checkouts/latest/kakaowork/__init__.py", line 8, in <module>
    from kakaowork.client import (Kakaowork, AsyncKakaowork)
  File "/home/docs/checkouts/readthedocs.org/user_builds/kakaowork-py/checkouts/latest/kakaowork/client.py", line 5, in <module>
    import aiosonic
  File "/home/docs/checkouts/readthedocs.org/user_builds/kakaowork-py/envs/latest/lib/python3.7/site-packages/aiosonic/__init__.py", line 31, in <module>
    import chardet
ModuleNotFoundError: No module named 'chardet'

Only can use plural command now. (ex) messages
So need to support singular command and alias (ex) message, msg

Python 3.6 support will be dropped according to the Python EOS schedule. (2021-12-23)

https://docs.kakaoi.ai/kakao_work/webapireference/messages/#messagessend_by_email

See https://docs.kakaoi.ai/kakao_work/webapireference/users/

Needs HTTP Request Handler / Response Model
Ref https://docs.kakaoi.ai/kakao_work/webapireference/reactive/

Currently, CLI is unfriendly because there is no help to use, so it needs to be fix

Support command line to send a message. (Fixes command code)

implements async (coroutines) API. Refer asyncio

I use the aiosonic package to solve this issue because it has fewer dependencies and supports Python 3.6 or higher.

Add AsyncKakaowork in the client module using the same API of Kakaowork except the async keyword.

See https://github.com/samuelcolvin/pydantic

Downgrade minimum required version as compatible as possible

Implements BlockKit API to load blocks from JSON file(s).

Needs to create examples for users.

Contents

• Querying something (sync/async)
• Sending a message with blocks using blockkit and blockkitbuilder (sync/async)
• Extending a reactive callback