update README

alexeev-prog · alexeev-prog · commit 678e5e811547 · 2024-12-11T19:38:13.000+07:00
diff --git a/Doxyfile b/Doxyfile
@@ -48,7 +48,7 @@ PROJECT_NAME           = "pyEchoNext"
 # could be handy for archiving the generated documentation or if some version
 # control system is used.
 
-PROJECT_NUMBER         = "0.6.10"
+PROJECT_NUMBER         = "0.6.11"
 
 # Using the PROJECT_BRIEF tag one can provide an optional one line description
 # for a project that appears at the top of each page and should give viewer a
diff --git a/README.md b/README.md
@@ -39,9 +39,13 @@
 
 Welcome to **EchoNext**, where innovation meets simplicity! Are you tired of the sluggishness of traditional web frameworks? Want a solution that keeps pace with your ambitious apps? Look no further. EchoNext is your agile companion in the world of web development!
 
+<p align="center">
+    <img src="https://raw.githubusercontent.com/alexeev-prog/pyEchoNext/refs/heads/main/docs/logo.jpg" width='600px' height='600px'>
+</p>
+
 **Imagine** a lightweight framework that empowers you to create modern web applications with lightning speed and flexibility. With EchoNext, you're not just coding; you're building a masterpiece!
 
- > Last stable version: 0.6.10 alpha
+ > Last stable version: 0.6.11 alpha
 
  > Next Big Update: ASYNC & unicorn support
 
@@ -758,6 +762,13 @@ class IndexView(View):
         return Response(request, body="Message has accepted!")
 ```
 
+## Tests coverage
+To test the web framework, PyTest with the pytest-cov plugin is used. You can look at the tests in [tests directory](./tests)
+
+| Statements | Miss       | Coverage |
+|------------|------------|----------|
+| 1327       | 997        | 28%      |
+
 ## Documentation 🌍
 Extended documentation and framework specifications are available at the following links:
 
diff --git a/SECURITY.md b/SECURITY.md
@@ -7,6 +7,7 @@ currently being supported with security updates.
 
 | Version | Supported          |
 | ------- | ------------------ |
+| 0.6.11  | :white_check_mark: |
 | 0.6.10  | :white_check_mark: |
 | 0.6.9   | :white_check_mark: |
 | 0.5.9   | :white_check_mark: |
diff --git a/docs/logo.jpg b/docs/logo.jpg
diff --git a/examples/example_module.py b/examples/example_module.py
@@ -1,10 +1,10 @@
 import os
 
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
-TEMPLATES_DIR = 'templates'
-SECRET_KEY = 'secret-key'
-LOCALE = 'DEFAULT'
+TEMPLATES_DIR = "templates"
+SECRET_KEY = "secret-key"
+LOCALE = "DEFAULT"
 LOCALE_DIR = None
-VERSION = '0.1.0'
-DESCRIPTION = 'Example echonext webapp'
-STATIC_DIR = 'static'
+VERSION = "0.1.0"
+DESCRIPTION = "Example echonext webapp"
+STATIC_DIR = "static"
diff --git a/pyechonext/__init__.py b/pyechonext/__init__.py
@@ -22,7 +22,7 @@
 from rich import print
 from rich.traceback import install
 
-__version__ = "0.6.9"
+__version__ = "0.6.11"
 install(show_locals=True)
 
 
diff --git a/pyechonext/apidoc_ui/ui.py b/pyechonext/apidoc_ui/ui.py
@@ -10,8 +10,8 @@ def __init__(self, specification: dict):
 		"""
 		Constructs a new instance.
 
-		:param		specification:	The specification
-		:type		specification:	dict
+		:param		  specification:	The specification
+		:type		 specification:	   dict
 		"""
 		self.specification = specification
 
@@ -27,19 +27,19 @@ def generate_section(
 		"""
 		generate section
 
-		:param		route:			 The route
-		:type		route:			 str
-		:param		summary_get:	 The summary get
-		:type		summary_get:	 str
-		:param		summary_post:	 The summary post
-		:type		summary_post:	 str
-		:param		get_responses:	 The get responses
-		:type		get_responses:	 dict
-		:param		post_responses:	 The post responses
-		:type		post_responses:	 dict
+		:param		  route:			 The route
+		:type		 route:				str
+		:param		  summary_get:	   The summary get
+		:type		 summary_get:	  str
+		:param		  summary_post:		The summary post
+		:type		 summary_post:	   str
+		:param		  get_responses:	 The get responses
+		:type		 get_responses:		dict
+		:param		  post_responses:	  The post responses
+		:type		 post_responses:	 dict
 
-		:returns:	template section
-		:rtype:		str
+		:returns:	 template section
+		:rtype:		   str
 		"""
 
 		template = f"""
@@ -77,8 +77,8 @@ def generate_html_page(self) -> str:
 		"""
 		Generate html page template
 
-		:returns:	template
-		:rtype:		str
+		:returns:	 template
+		:rtype:		   str
 		"""
 		template = """
 <!DOCTYPE html>
@@ -114,11 +114,11 @@ def generate_html_page(self) -> str:
 			font-family: monospace;
 			margin: 10px;
 			padding: 10px;
-			white-space: pre-wrap;		 /* Since CSS 2.1 */
-			white-space: -moz-pre-wrap;	 /* Mozilla, since 1999 */
-			white-space: -pre-wrap;		 /* Opera 4-6 */
-			white-space: -o-pre-wrap;	 /* Opera 7 */
-			word-wrap: break-word;		 /* Internet Explorer 5.5+ */
+			white-space: pre-wrap;		   /* Since CSS 2.1 */
+			white-space: -moz-pre-wrap;		/* Mozilla, since 1999 */
+			white-space: -pre-wrap;			/* Opera 4-6 */
+			white-space: -o-pre-wrap;	  /* Opera 7 */
+			word-wrap: break-word;		   /* Internet Explorer 5.5+ */
 		}
 		code{
 		border-radius: 5px;
@@ -208,17 +208,17 @@ def generate_html_page(self) -> str:
 Atom One Light by Daniel Gamage
 Original One Light Syntax theme from https://github.com/atom/one-light-syntax
 
-base:	 #fafafa
-mono-1:	 #383a42
-mono-2:	 #686b77
-mono-3:	 #a0a1a7
-hue-1:	 #0184bb
-hue-2:	 #4078f2
-hue-3:	 #a626a4
-hue-4:	 #50a14f
-hue-5:	 #e45649
+base:	  #fafafa
+mono-1:		#383a42
+mono-2:		#686b77
+mono-3:		#a0a1a7
+hue-1:	   #0184bb
+hue-2:	   #4078f2
+hue-3:	   #a626a4
+hue-4:	   #50a14f
+hue-5:	   #e45649
 hue-5-2: #c91243
-hue-6:	 #986801
+hue-6:	   #986801
 hue-6-2: #c18401
 
 */
diff --git a/pyechonext/app.py b/pyechonext/app.py
@@ -9,8 +9,7 @@
 
 from pyechonext.cache import InMemoryCache
 from pyechonext.config import Settings
-from pyechonext.i18n_l10n.i18n import JSONi18nLoader
-from pyechonext.i18n_l10n.l10n import JSONLocalizationLoader
+from pyechonext.i18n_l10n import JSONi18nLoader, JSONLocalizationLoader
 from pyechonext.logging import setup_logger
 from pyechonext.middleware import BaseMiddleware
 from pyechonext.request import Request
diff --git a/pyechonext/i18n_l10n/__init__.py b/pyechonext/i18n_l10n/__init__.py
@@ -0,0 +1,4 @@
+from pyechonext.i18n_l10n.i18n import JSONi18nLoader, LanguageManager
+from pyechonext.i18n_l10n.l10n import JSONLocalizationLoader
+
+all = [JSONi18nLoader, LanguageManager, JSONLocalizationLoader]
diff --git a/pyechonext/i18n_l10n/i18n.py b/pyechonext/i18n_l10n/i18n.py
@@ -52,7 +52,7 @@ class JSONi18nLoader(i18nInterface):
 		"description": "This web application is an example of the pyEchonext web framework.",
 	}
 
-	def __init__(self, locale: str, directory: str):
+	def __init__(self, locale: str = "DEFAULT", directory: str = None):
 		"""
 		Constructs a new instance.
 
@@ -135,7 +135,7 @@ def __init__(self, loader: i18nInterface):
 		"""
 		self.loader = loader
 
-	def translate(self, key: str) -> str:
+	def translate(self, key: str, **kwargs) -> str:
 		"""
 		Translate
 
@@ -145,4 +145,4 @@ def translate(self, key: str) -> str:
 		:returns:	translated string
 		:rtype:		str
 		"""
-		return self.loader.get_string(key)
+		return self.loader.get_string(key, **kwargs)
diff --git a/pyechonext/i18n_l10n/l10n.py b/pyechonext/i18n_l10n/l10n.py
@@ -108,8 +108,8 @@ class JSONLocalizationLoader(LocalizationInterface):
 
 	def __init__(
 		self,
-		locale: str,
-		directory: str,
+		locale: str = 'DEFAULT',
+		directory: str = None,
 		custom_settings: Optional[Dict[str, Any]] = None,
 	):
 		"""
@@ -177,7 +177,7 @@ def format_date(self, date: datetime, date_format: Optional[str] = None) -> str:
 			else date_format
 		)
 
-		formatted_date = date_time_fromat.strftime(date_time_fromat)
+		formatted_date = date.strftime(date_time_fromat)
 
 		return formatted_date
 
diff --git a/pyechonext/request.py b/pyechonext/request.py
@@ -11,7 +11,7 @@ class Request:
 	This class describes a request.
 	"""
 
-	def __init__(self, environ: dict, settings: Settings):
+	def __init__(self, environ: dict = {}, settings: Settings = None):
 		"""
 		Constructs a new instance.
 
@@ -20,13 +20,13 @@ def __init__(self, environ: dict, settings: Settings):
 		"""
 		self.environ: dict = environ
 		self.settings: Settings = settings
-		self.method: str = self.environ["REQUEST_METHOD"]
-		self.path: str = self.environ["PATH_INFO"]
-		self.GET: dict = self._build_get_params_dict(self.environ["QUERY_STRING"])
+		self.method: str = self.environ.get("REQUEST_METHOD")
+		self.path: str = self.environ.get("PATH_INFO")
+		self.GET: dict = self._build_get_params_dict(self.environ.get("QUERY_STRING"))
 		self.POST: dict = self._build_post_params_dict(
-			self.environ["wsgi.input"].read()
+			self.environ.get("wsgi.input").read()
 		)
-		self.user_agent: str = self.environ["HTTP_USER_AGENT"]
+		self.user_agent: str = self.environ.get("HTTP_USER_AGENT")
 		self.extra: dict = {}
 
 		logger.debug(f"New request created: {self.method} {self.path}")
diff --git a/pyechonext/response.py b/pyechonext/response.py
@@ -20,14 +20,14 @@ class Response:
 
 	def __init__(
 		self,
-		request: Request,
+		request: Request = None,
 		use_i18n: bool = False,
 		status_code: Optional[int] = 200,
 		body: Optional[str] = None,
 		headers: Optional[Dict[str, str]] = {},
 		content_type: Optional[str] = None,
 		charset: Optional[str] = None,
-		**kwargs,
+		i18n_params: Optional[dict] = {},
 	):
 		"""
 		Constructs a new instance.
@@ -75,7 +75,7 @@ def __init__(
 		self.extra: dict = {}
 
 		self.use_i18n: bool = use_i18n
-		self.i18n_kwargs = kwargs
+		self.i18n_kwargs = i18n_params
 
 		self._update_headers()
 
@@ -172,10 +172,10 @@ def json(self) -> dict:
 		:rtype:		dict
 		"""
 		if self.body:
-			if self.content_type.split("/")[-1] == "json":
-				return json.dumps(self.body)
+			if self.content_type == "application/json":
+				return json.loads(self.body)
 			else:
-				return json.dumps(self.body.decode("UTF-8"))
+				return json.dumps(self.body)
 
 		return {}
 
diff --git a/pyechonext/static.py b/pyechonext/static.py
@@ -14,7 +14,7 @@ class StaticFile:
 	This class describes a static file.
 	"""
 
-	def __init__(self, settings: Settings, filename: str):
+	def __init__(self, settings: Settings = None, filename: str = None):
 		"""
 		Constructs a new instance.
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyechonext"
-version = "0.6.10"
+version = "0.6.11"
 description = "EchoNext is a lightweight, fast and scalable web framework for Python"
 authors = ["alexeev-prog <alexeev.dev@mail.ru>"]
 license = "LGPL-2.1"
@@ -19,12 +19,14 @@ fire = "^0.7.0"
 python-dotenv = "^1.0.1"
 toml = "^0.10.2"
 pyyaml = "^6.0.2"
-black = "^24.10.0"
-pylint = "^3.3.2"
+requests = "^2.32.3"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.3.0"
 ruff = ">=0.6.9"
+black = "^24.10.0"
+pylint = "^3.3.2"
+pytest-cov = "^6.0.0"
 
 [build-system]
 requires = ["poetry-core"]
diff --git a/tests/permissions.py b/tests/permissions.py
