Readme: reformat

Author: daniel-jones-dev

README.md

@@ -4,37 +4,46 @@
 [![Supported Python versions](https://img.shields.io/pypi/pyversions/deepl.svg)](https://pypi.org/project/deepl/)
 [![License: MIT](https://img.shields.io/badge/license-MIT-blueviolet.svg)](https://github.com/DeepLcom/deepl-python/blob/main/LICENSE)
 
-The [DeepL API][api-docs] is a language
-translation API that allows other computer programs to send texts and documents to DeepL's servers and receive
-high-quality translations. This opens a whole universe of opportunities for developers: any translation product you can
-imagine can now be built on top of DeepL's best-in-class translation technology.
+The [DeepL API][api-docs] is a language translation API that allows other
+computer programs to send texts and documents to DeepL's servers and receive
+high-quality translations. This opens a whole universe of opportunities for
+developers: any translation product you can imagine can now be built on top of
+DeepL's best-in-class translation technology.
 
-The DeepL Python library offers a convenient way for applications written in Python to interact with the DeepL API. We
-intend to support all API functions with the library, though support for new features may be added to the library after
-they’re added to the API.
+The DeepL Python library offers a convenient way for applications written in
+Python to interact with the DeepL API. We intend to support all API functions
+with the library, though support for new features may be added to the library
+after they’re added to the API.
 
+## Getting an authentication key
 
-## Getting an authentication key 
+To use the DeepL Python Library, you'll need an API authentication key. To get a
+key, [please create an account here][create-account]. You can translate up to
+500,000 characters/month for free.
 
-To use the DeepL Python Library, you'll need an API authentication key. To get a key, [please create an account here][create-account]. You can translate up to 500,000 characters/month for free. 
-
-After you have created an account, you can find your API authentication key on your [DeepL Pro Account][pro-account].
+After you have created an account, you can find your API authentication key on
+your [DeepL Pro Account][pro-account].
 
 ## Installation
+
 The library can be installed from [PyPI][pypi-project] using pip:
+
 ```shell
 pip install --upgrade deepl
 ```
 
 If you need to modify this source code, install the dependencies using poetry:
+
 ```shell
 poetry install
 ```
 
 ### Requirements
-The library is tested with Python versions 3.6 to 3.10. 
 
-The `requests` module is used to perform HTTP requests; the minimum is version 2.0.
+The library is tested with Python versions 3.6 to 3.10.
+
+The `requests` module is used to perform HTTP requests; the minimum is version
+2.0.
 
 ## Usage
 
@@ -55,7 +64,8 @@ print(result)  # "Bonjour, le monde !"
 # Note: printing or converting the result to a string uses the output text
 
 # Translate multiple texts into British English
-result = translator.translate_text(["お元気ですか？", "¿Cómo estás?"], target_lang="EN-GB")
+result = translator.translate_text(["お元気ですか？", "¿Cómo estás?"],
+                                   target_lang="EN-GB")
 print(result[0].text)  # "How are you?"
 print(result[0].detected_source_lang)  # "JA"
 print(result[1].text)  # "How are you?"
@@ -77,7 +87,8 @@ except deepl.DocumentTranslationException as error:
     # DeepL support.
     doc_id = error.document_handle.id
     doc_key = error.document_handle.key
-    print(f"Error after uploading document ${error}, id: ${doc_id} key: ${doc_key}")
+    print(
+        f"Error after uploading document ${error}, id: ${doc_id} key: ${doc_key}")
 except deepl.DeepLException as error:
     # Errors during upload raise a DeepLException
     print(error)
@@ -100,13 +111,13 @@ without_glossary = translator.translate_text(
 )
 print(without_glossary)  # "Der Künstler wurde mit einem Preis ausgezeichnet."
 
-
 # Check account usage
 usage = translator.get_usage()
 if usage.character.limit_exceeded:
     print("Character limit exceeded.")
 else:
-    print(f"Character usage: {usage.character.count} of {usage.character.limit}")
+    print(
+        f"Character usage: {usage.character.count} of {usage.character.limit}")
 
 # Source and target languages
 print("Source languages:")
@@ -122,43 +133,59 @@ for language in translator.get_target_languages():
 ```
 
 ### Exceptions
+
 All module functions may raise `deepl.DeepLException` or one of its subclasses.
-If invalid arguments are provided, they may raise the standard exceptions `ValueError` and `TypeError`.
+If invalid arguments are provided, they may raise the standard exceptions
+`ValueError` and `TypeError`.
 
 ### Configuration
 
 #### Logging
-Logging can be enabled to see the HTTP-requests sent and responses received by the library. Enable and control logging
-using Python's logging module, for example:
+
+Logging can be enabled to see the HTTP-requests sent and responses received by
+the library. Enable and control logging using Python's logging module, for
+example:
+
 ```python
 import logging
+
 logging.basicConfig()
 logging.getLogger('deepl').setLevel(logging.DEBUG)
 ```
 
 #### Proxy configuration
-You can configure a proxy by specifying the `proxy` argument when creating a `deepl.Translator`:
+
+You can configure a proxy by specifying the `proxy` argument when creating a
+`deepl.Translator`:
+
 ```python
 proxy = "http://user:[email protected]:3128"
 translator = deepl.Translator(..., proxy=proxy)
 ```
 
 The proxy argument is passed to the underlying `requests` session,
-[see the documentation here][requests-proxy-docs]; a dictionary of schemes
-to proxy URLs is also accepted.
+[see the documentation here][requests-proxy-docs]; a dictionary of schemes to
+proxy URLs is also accepted.
 
 ## Command Line Interface
-The library can be run on the command line supporting all API functions. Use the `--help` option for 
-usage information:
+
+The library can be run on the command line supporting all API functions. Use the
+`--help` option for usage information:
+
 ```shell
 python3 -m deepl --help
 ```
-The CLI requires your DeepL authentication key specified either as the `DEEPL_AUTH_KEY` environment variable, or using
-the `--auth-key` option, for example:
+
+The CLI requires your DeepL authentication key specified either as the
+`DEEPL_AUTH_KEY` environment variable, or using the `--auth-key` option, for
+example:
+
 ```shell
 python3 -m deepl --auth-key=YOUR_AUTH_KEY usage
 ```
-Note that the `--auth-key` argument must appear *before* the command argument. The recognized commands are:
+
+Note that the `--auth-key` argument must appear *before* the command argument.
+The recognized commands are:
 
 | Command   | Description                                            |
 | :-------- | :----------------------------------------------------- |
@@ -169,38 +196,51 @@ Note that the `--auth-key` argument must appear *before* the command argument. T
 | glossary  | create, list, and remove glossaries                    |
 
 For example, to translate text:
+
 ```shell
 python3 -m deepl --auth-key=YOUR_AUTH_KEY text --to=DE "Text to be translated."
 ```
-Wrap text arguments in quotes to prevent the shell from splitting sentences into words.
+
+Wrap text arguments in quotes to prevent the shell from splitting sentences into
+words.
 
 ## Issues
 
-If you experience problems using the library, or would like to request a new feature, please open an
-[issue][issues]. 
+If you experience problems using the library, or would like to request a new
+feature, please open an [issue][issues].
 
 ## Development
 
-We are currently unable to accept Pull Requests. If you would like to suggest changes, please open an issue instead.
+We are currently unable to accept Pull Requests. If you would like to suggest
+changes, please open an issue instead.
 
-### Tests 
+### Tests
 
-Execute the tests using `pytest`. The tests communicate with the DeepL API using the auth key defined by the
-`DEEPL_AUTH_KEY` environment variable.
+Execute the tests using `pytest`. The tests communicate with the DeepL API using
+the auth key defined by the `DEEPL_AUTH_KEY` environment variable.
 
-Be aware that the tests make DeepL API requests that contribute toward your API usage.
+Be aware that the tests make DeepL API requests that contribute toward your API
+usage.
 
-The test suite may instead be configured to communicate with the mock-server provided by
-[deepl-mock][deepl-mock]. Although most test cases work for either, some test cases work
-only with the DeepL API or the mock-server and will be otherwise skipped.  The test cases that require the mock-server
-trigger server errors and test the client error-handling. To execute the tests using deepl-mock, run it in another
-terminal while executing the tests. Execute the tests using `pytest` with the `DEEPL_MOCK_SERVER_PORT` and
-`DEEPL_SERVER_URL` environment variables defined referring to the mock-server.
+The test suite may instead be configured to communicate with the mock-server
+provided by [deepl-mock][deepl-mock]. Although most test cases work for either,
+some test cases work only with the DeepL API or the mock-server and will be
+otherwise skipped. The test cases that require the mock-server trigger server
+errors and test the client error-handling. To execute the tests using
+deepl-mock, run it in another terminal while executing the tests. Execute the
+tests using `pytest` with the `DEEPL_MOCK_SERVER_PORT` and `DEEPL_SERVER_URL`
+environment variables defined referring to the mock-server.
 
 [api-docs]: https://www.deepl.com/docs-api?utm_source=github&utm_medium=github-python-readme
+
 [create-account]: https://www.deepl.com/pro?utm_source=github&utm_medium=github-python-readme#developer
+
 [deepl-mock]: https://www.github.com/DeepLcom/deepl-mock
+
 [issues]: https://www.github.com/DeepLcom/deepl-python/issues
+
 [pypi-project]: https://pypi.org/project/deepl/
+
 [pro-account]: https://www.deepl.com/pro-account/?utm_source=github&utm_medium=github-python-readme
-[requests-proxy-docs]: https://docs.python-requests.org/en/latest/user/advanced/#proxies
+
+[requests-proxy-docs]: https://docs.python-requests.org/en/latest/user/advanced/#proxies