feat: Add support of Python 3.12

Extend pre-commit-hook with `markdownlint`

.pre-commit-config.yaml

@@ -37,11 +37,8 @@ repos:
  files: ^async_customerio/
  additional_dependencies: [types-setuptools]
 
- - repo: https://github.com/executablebooks/mdformat
- rev: 0.7.17
+ - repo: https://github.com/igorshubovych/markdownlint-cli
+ rev: v0.38.0
  hooks:
- - id: mdformat
- # Optionally add plugins
- additional_dependencies:
- - mdformat-gfm
- - mdformat-black
+ - id: markdownlint
+ args: [--fix, --disable=MD013, --disable=MD041]

CHANGES.md

@@ -3,11 +3,11 @@
 ## 1.3.0
 
 - Support of Python 3.12 added.
-- \[FIX\] Add missing dependency `type_extensions` to be able using type annotations on Python 3.7
+- [FIX] Add missing dependency `type_extensions` to be able using type annotations on Python 3.7
 
 ## 1.2.0
 
-- Added support of sending transactional push notifications. More details of how to send Push Notifications via CustomerIO https://customer.io/docs/journeys/transactional-api/#transactional-push-notifications
+- Added support of sending transactional push notifications. More details of how to send Push Notifications via CustomerIO <https://customer.io/docs/journeys/transactional-api/#transactional-push-notifications>
 
 ## 1.1.0
 
@@ -16,8 +16,8 @@
 ## 1.0.0
 
 - \[BREAKING\] For consistency across APIs following actions have been taken:
- - Renamed transactional email request optional arguments `amp_body` to `body_amp` and `plaintext_body` to `body_plain`
- - Changed transactional email request default values for optional boolean arguments `disable_css_preproceessing`, `queue_draft`, `disable_message_retention`, `tracked`, `send_to_unsubscribed`
+- Renamed transactional email request optional arguments `amp_body` to `body_amp` and `plaintext_body` to `body_plain`
+- Changed transactional email request default values for optional boolean arguments `disable_css_preproceessing`, `queue_draft`, `disable_message_retention`, `tracked`, `send_to_unsubscribed`
 
 ## 0.5.1
 

CODE_OF_CONDUCT.md

@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
 Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
 

README.md

@@ -20,7 +20,7 @@
 ## Installation
 
 ```shell script
-$ pip install async-customerio
+pip install async-customerio
 ```
 
 ## Getting started
@@ -51,7 +51,7 @@ if __name__ == "__main__":
  asyncio.run(main())
 ```
 
-#### Instantiating `AsyncCustomerIO` object
+### Instantiating `AsyncCustomerIO` object
 
 Create an instance of the client with your [Customer.io credentials](https://fly.customer.io/settings/api_credentials).
 

SECURITY.md

@@ -10,6 +10,6 @@ As of December 7, 2022:
 
 ## Reporting a Vulnerability
 
-Please report (suspected) security vulnerabilities to [email protected].
+Please report (suspected) security vulnerabilities to <[email protected]>.
 You will receive a response from us within 48 hours. If the issue is confirmed,
 we will release a patch as soon as possible depending on complexity.