PR-24: Bug fixes and minor typos (#24)

## v1.0.4 - 2024-02-04
### What's Changed
**full changelog**: v1.0.3...v1.0.4 by @ obervinov #24
#### 📚 Bug Fixes
* [List all supported versions of python](#23)
* [Soft handling of situations where a configuration file or alias does not exist](#22)

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: obervinov

.github/workflows/pr.yaml

@@ -10,13 +10,13 @@ on:
 
 jobs:
   changelog:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   pylint:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   pytest:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   pyproject:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13

.github/workflows/release.yaml

@@ -9,17 +9,17 @@ on:
 
 jobs:
   changelog:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   pylint:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   pytest:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   pyproject:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
 
   create-release:
-    uses: obervinov/_templates/.github/workflows/[email protected].12
+    uses: obervinov/_templates/.github/workflows/[email protected].13
     needs: [changelog, pylint, pytest, pyproject]

CHANGELOG.md

@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
 
+## v1.0.4 - 2024-02-04
+### What's Changed
+**full changelog**: https://github.com/obervinov/messages-package/compare/v1.0.3...v1.0.4 by @ obervinov https://github.com/obervinov/messages-package/pull/24
+#### 📚 Bug Fixes
+* [List all supported versions of python](https://github.com/obervinov/messages-package/issues/23)
+* [Soft handling of situations where a configuration file or alias does not exist](https://github.com/obervinov/messages-package/issues/22)
+
+
 ## v1.0.3 - 2024-01-29
 ### What's Changed
 **full changelog**: https://github.com/obervinov/messages-package/compare/v1.0.2...v1.0.3 by @ obervinov https://github.com/obervinov/messages-package/pull/21

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 obervinov
+Copyright (c) 2024 obervinov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -123,5 +123,5 @@ print(
 _output result_
 ```python
 🏞 Messages from the queue have already been processed
-[◾◾◾◾◾◾◾◾◾◾◾◾◾◾◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻◻◻◻]19%
+[◾◾◾◾◾◾◾◾◾◾◾◾◾◾◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️◻️]19%
 ```

messages/messages.py

@@ -6,6 +6,7 @@
 import json
 import math
 import re
+from typing import Union
 import emoji
 
 
@@ -39,15 +40,25 @@ def __init__(
         else:
             self.config_path = 'configs/messages.json'
 
-        with open(self.config_path, 'r', encoding='UTF-8') as config_json:
-            self.data = json.load(config_json)
-        config_json.close()
+        if os.path.exists(self.config_path):
+            with open(self.config_path, 'r', encoding='UTF-8') as config_json:
+                try:
+                    self.data = json.load(config_json)
+                    config_json.close()
+                except json.JSONDecodeError as json_error:
+                    # pylint: disable=no-value-for-parameter
+                    raise json.JSONDecodeError(
+                        f"Configuration file {self.config_path} is not valid JSON: {json_error}\n"
+                        "https://github.com/obervinov/messages-package?tab=readme-ov-file#-usage-examples"
+                    )
+        else:
+            raise FileNotFoundError(f"Configuration file not found: {self.config_path}")
 
     def render_template(
         self,
         template_alias: str = None,
         **kwargs
-    ) -> str | None:
+    ) -> Union[str, None]:
         """
         Method for reading the text from the configuration file.
 
@@ -79,13 +90,14 @@ def render_template(
             # Building full message
             return template['text'].format(*arguments)
         except KeyError:
+            print(f"[Messages]: template not found: {template_alias}")
             return None
 
     def render_progressbar(
         self,
         total_count: int = 0,
         current_count: int = 0
-    ) -> str | None:
+    ) -> Union[str, None]:
         """
         A Method for generating string with a progress bar based
         on the transmitted statistics data.

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "messages"
-version = "1.0.3"
+version = "1.0.4"
 description = "This package helps to easily and quickly generate beautiful messages for telegram bots using templates described in json."
 authors = ["Bervinov Oleg <[email protected]>"]
 maintainers = ["Bervinov Oleg <[email protected]>"]
@@ -17,7 +17,7 @@ include = ["CHANGELOG.md"]
 "Bug Tracker" = "https://github.com/obervinov/messages-package/issues"
 
 [tool.poetry.dependencies]
-python = "^3.10"
+python = "^3.9 || ^3.10 || ^3.11"
 emoji  = "^2"
 
 [build-system]

pyproject.toml

@@ -1 +1,8 @@
-{"templates":{"test_message": {"text": "Hi, <b>{0}</b>! {1}\nAccess for your account - allowed {2}", "args": ["username", ":raised_hand:", ":unlocked:"]}}}
+{
+    "templates": {
+        "test_message": {
+            "text": "Hi, <b>{0}</b>! {1}\nAccess for your account - allowed {2}",
+            "args": ["username", ":raised_hand:", ":unlocked:"]
+        }
+    }
+}