Update docs and bump click dependency

Breaking: This changes the CLI command syntax from snake_case to dash-case

Co-authored-by: Lennart Grahl <lennart.grahl@gmail.com>

Author: RayJW

CHANGELOG.rst

@@ -1,25 +1,38 @@
 Changelog
 *********
 
+`6.0.0`_ (TBD)
+--------------
+
+General:
+
+- Add support for Python 3.10
+- Drop support for Python versions below 3.7
+- Major dependencies bump to increase compatibility with other packages
+- Updated all tests to work with the newest dependencies
+- Changed CLI syntax: All commands are now `dash-case` instead of `snake_case`,
+  e.g. the `send_e2e` command is now called `send-e2e`.
+
+
 `5.0.0`_ (2021-05-17)
 ---------------------
 
-- Added custom session and session arguments to `Connection` (#55, #56)
-- Removed the `fingerprint` and `verify_fingerprint` arguments, see #55 for a
+- Add custom session and session arguments to `Connection` (#55, #56)
+- Remove the `fingerprint` and `verify_fingerprint` arguments, see #55 for a
   detailed explanation and how to achieve pinning
 
 `4.0.0`_ (2021-01-23)
 ---------------------
 
 General:
 
-- Dropped support for Python versions below 3.6.1.
-- Deprecated `ReceiptType.user_ack` has been removed. Use
+- Drop support for Python versions below 3.6.1.
+- Remove `ReceiptType.user_ack` after deprecation. Use
   `ReceiptType.user_acknowledge` instead.
-- `util.aio_run` has been simplified. It does not allow for passing a specific
-  event loop or closing the event loop on completion any longer.
-- `util.aio_run_proxy_decorator` has been renamed to `aio_run_proxy` and now
-  always creates the class instance within a running event loop.
+- Simplify `util.aio_run`. It does not allow for passing a specific event loop
+  or closing the event loop on completion any longer.
+- Rename `util.aio_run_proxy_decorator` to `aio_run_proxy`. It now always
+  creates the class instance within a running event loop.
 
 Client:
 
@@ -66,6 +79,7 @@ Server:
 
 - Initial publication on PyPI
 
+.. _6.0.0: https://github.com/lgrahl/threema-msgapi-sdk-python/compare/v5.0.0...v6.0.0
 .. _5.0.0: https://github.com/lgrahl/threema-msgapi-sdk-python/compare/v4.0.0...v5.0.0
 .. _4.0.0: https://github.com/lgrahl/threema-msgapi-sdk-python/compare/v3.1.0...v4.0.0
 .. _3.1.0: https://github.com/lgrahl/threema-msgapi-sdk-python/compare/v3.0.6...v3.1.0

RELEASING.md

@@ -1,13 +1,13 @@
 Release Process
 ===============
 
-Signing key: https://lgrahl.de/pub/pgp-key.txt
+Signing key: <https://lgrahl.de/pub/pgp-key.txt>
 
 1. Check the code:
 
    ```bash
    flake8 .
-   isort -rc -c . || isort -rc -df
+   isort -c . || isort --df .
    mypy setup.py tests examples threema
    py.test
    ```
@@ -26,11 +26,11 @@ Signing key: https://lgrahl.de/pub/pgp-key.txt
 
 4. Do a signed commit and signed tag of the release:
 
-  ```bash
-  git add threema/gateway/__init__.py CHANGELOG.rst
-  git commit -S${GPG_KEY} -m "Release v${VERSION}"
-  git tag -u ${GPG_KEY} -m "Release v${VERSION}" v${VERSION}
-  ```
+   ```bash
+   git add threema/gateway/__init__.py CHANGELOG.rst
+   git commit -S${GPG_KEY} -m "Release v${VERSION}"
+   git tag -u ${GPG_KEY} -m "Release v${VERSION}" v${VERSION}
+   ```
 
 5. Build source and binary distributions:
 
@@ -69,4 +69,3 @@ Signing key: https://lgrahl.de/pub/pgp-key.txt
    ```
 
 10. Pat yourself on the back and celebrate!
-

mypy.ini

@@ -1,3 +1,3 @@
 [mypy]
-python_version = 3.7
+python_version = 3.10
 ignore_missing_imports = True

setup.py

@@ -42,7 +42,7 @@ def read(file):
     'pytest-cov>=3.0.0,<4',
     'flake8==4.0.1',
     'isort==5.10.1',
-    'collective.checkdocs>=0.2',
+    'collective.checkdocs>=0.2,<0.3',
     'Pygments>=2.12.0',  # required by checkdocs
     'mypy==0.961',
 ]
@@ -54,7 +54,7 @@ def read(file):
     install_requires=[
         'logbook>=1.1.0,<2',
         'libnacl>=1.5.2,<2',
-        'click>=6.7,<7',  # doesn't seem to follow semantic versioning
+        'click>=8,<9',
         'aiohttp>=3.7.3,<4',
         'wrapt>=1.10.10,<2',
     ],

tests/test_cli.py

@@ -91,18 +91,18 @@ async def test_derive(self, cli):
     @pytest.mark.asyncio
     async def test_send_simple(self, cli):
         id_, secret = pytest.msgapi['msgapi']['id'], pytest.msgapi['msgapi']['secret']
-        output = await cli('send_simple', 'ECHOECHO', id_, secret, input='Hello!')
+        output = await cli('send-simple', 'ECHOECHO', id_, secret, input='Hello!')
         assert output
 
     @pytest.mark.asyncio
     async def test_send_e2e(self, cli, server):
         output_1 = await cli(
-            'send_e2e', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-e2e', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             input='Hello!')
         assert output_1
         output_2 = await cli(
-            'send_e2e', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-e2e', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'], '-k',
             server.echoecho_encoded_key, input='Hello!')
         assert output_2
@@ -112,13 +112,13 @@ async def test_send_e2e(self, cli, server):
     async def test_send_image(self, cli, server):
         server.latest_blob_ids = []
         output_1 = await cli(
-            'send_image', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-image', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_jpg)
         assert output_1
         assert len(server.latest_blob_ids) == 1
         output_2 = await cli(
-            'send_image', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-image', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_jpg, '-k', server.echoecho_encoded_key)
         assert output_2
@@ -129,20 +129,20 @@ async def test_send_image(self, cli, server):
     async def test_send_video(self, cli, server):
         server.latest_blob_ids = []
         output_1 = await cli(
-            'send_video', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-video', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_mp4, server.threema_jpg)
         assert output_1
         assert len(server.latest_blob_ids) == 2
         output_2 = await cli(
-            'send_video', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-video', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_mp4, server.threema_jpg, '-k', server.echoecho_encoded_key)
         assert output_2
         assert output_1 == output_2
         assert len(server.latest_blob_ids) == 4
         output = await cli(
-            'send_video', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-video', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_mp4, server.threema_jpg, '-d', '1337')
         assert output
@@ -152,26 +152,26 @@ async def test_send_video(self, cli, server):
     async def test_send_file(self, cli, server):
         server.latest_blob_ids = []
         output_1 = await cli(
-            'send_file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_jpg)
         assert output_1
         assert len(server.latest_blob_ids) == 1
         output_2 = await cli(
-            'send_file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_jpg, '-k', server.echoecho_encoded_key)
         assert output_2
         assert output_1 == output_2
         assert len(server.latest_blob_ids) == 2
         output = await cli(
-            'send_file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_jpg, '-t', server.threema_jpg)
         assert output
         assert len(server.latest_blob_ids) == 4
         output = await cli(
-            'send_file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
+            'send-file', 'ECHOECHO', pytest.msgapi['msgapi']['id'],
             pytest.msgapi['msgapi']['secret'], pytest.msgapi['msgapi']['private'],
             server.threema_jpg, '-k', server.echoecho_encoded_key, '-t',
             server.threema_jpg)
@@ -253,5 +253,5 @@ async def test_insufficient_credits(self, cli):
         with pytest.raises(subprocess.CalledProcessError) as exc_info:
             id_, secret = pytest.msgapi['msgapi']['nocredit_id'],\
                 pytest.msgapi['msgapi']['secret']
-            await cli('send_simple', 'ECHOECHO', id_, secret, input='!')
+            await cli('send-simple', 'ECHOECHO', id_, secret, input='!')
         assert 'Insufficient credits' in exc_info.value.output

threema/gateway/__init__.py

@@ -30,7 +30,7 @@
 
 __author__ = 'Lennart Grahl <lennart.grahl@gmail.com>'
 __status__ = 'Production'
-__version__ = '5.0.0'
+__version__ = '6.0.0'
 feature_level = 3
 
 __all__ = tuple(itertools.chain(