From 1201e915338c0afccaffd87a6489b8d1e3c8654e Mon Sep 17 00:00:00 2001 From: Aleksandr Omyshev Date: Fri, 15 Dec 2023 14:50:07 +0200 Subject: [PATCH] feat: Add support of Python 3.12 Extend pre-commit-hook with `markdownlint` --- .pre-commit-config.yaml | 11 ++++------- CHANGES.md | 8 ++++---- CODE_OF_CONDUCT.md | 2 +- README.md | 4 ++-- SECURITY.md | 2 +- 5 files changed, 12 insertions(+), 15 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3d6655c..efadbf9 100644 --- a/.pre-commit-config.yaml +++ b/.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] diff --git a/CHANGES.md b/CHANGES.md index 0e93553..f48878a 100644 --- a/CHANGES.md +++ b/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 ## 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 diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b3abd29..cb19889 100644 --- a/CODE_OF_CONDUCT.md +++ b/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 developers@healthjoy.com. 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 . 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. diff --git a/README.md b/README.md index 6ba6efa..ddb12b8 100644 --- a/README.md +++ b/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). diff --git a/SECURITY.md b/SECURITY.md index 0ea1742..0ffadff 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -10,6 +10,6 @@ As of December 7, 2022: ## Reporting a Vulnerability -Please report (suspected) security vulnerabilities to security@healthjoy.com. +Please report (suspected) security vulnerabilities to . 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.