core-https 1.1.1__tar.gz → 1.1.3__tar.gz

{core_https-1.1.1 → core_https-1.1.3}/PKG-INFO

@@ -1,12 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: core-https
-Version: 1.1.1
+Version: 1.1.3
 Summary: This project/library contains common elements related to HTTP & API services...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
 License: MIT
 Project-URL: Homepage, https://gitlab.com/bytecode-solutions/core/core-https
 Project-URL: Repository, https://gitlab.com/bytecode-solutions/core/core-https
+Project-URL: Documentation, https://core-https.readthedocs.io/en/latest/
 Project-URL: Issues, https://gitlab.com/bytecode-solutions/core/core-https/-/issues
 Project-URL: Changelog, https://gitlab.com/bytecode-solutions/core/core-https/-/blob/master/CHANGELOG.md
 Classifier: License :: OSI Approved :: MIT License
@@ -31,37 +32,42 @@ Requires-Dist: urllib3>=2.2.3; python_version >= "3.8"
 Requires-Dist: urllib3>=1.26.20; python_version >= "3.7" and python_version < "3.8"
 Requires-Dist: typing-extensions>=4.8.0; python_version >= "3.8" and python_version < "3.11"
 Requires-Dist: typing-extensions>=4.2.0; python_version >= "3.7" and python_version < "3.8"
+Provides-Extra: docs
+Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "docs"
+Requires-Dist: Sphinx==8.2.3; extra == "docs"
+Dynamic: license-file
 
 # core-https
 _______________________________________________________________________________
 
-This project/library contains common elements related to HTTP & API services...
+This project/library contains common elements related to HTTP...
 
 ## Execution Environment
 
 ### Install libraries
-```commandline
+```shell
 pip install --upgrade pip 
 pip install virtualenv
 ```
 
 ### Create the Python Virtual Environment.
-```commandline
+```shell
+virtualenv --python={{python-version}} .venv
 virtualenv --python=python3.11 .venv
 ```
 
 ### Activate the Virtual Environment.
-```commandline
+```shell
 source .venv/bin/activate
 ```
 
 ### Install required libraries.
-```commandline
+```shell
 pip install .
 ```
 
 ### Check tests and coverage...
-```commandline
+```shell
 python manager.py run-test
 python manager.py run-coverage
 ```

{core_https-1.1.1 → core_https-1.1.3}/README.md

@@ -1,33 +1,34 @@
 # core-https
 _______________________________________________________________________________
 
-This project/library contains common elements related to HTTP & API services...
+This project/library contains common elements related to HTTP...
 
 ## Execution Environment
 
 ### Install libraries
-```commandline
+```shell
 pip install --upgrade pip 
 pip install virtualenv
 ```
 
 ### Create the Python Virtual Environment.
-```commandline
+```shell
+virtualenv --python={{python-version}} .venv
 virtualenv --python=python3.11 .venv
 ```
 
 ### Activate the Virtual Environment.
-```commandline
+```shell
 source .venv/bin/activate
 ```
 
 ### Install required libraries.
-```commandline
+```shell
 pip install .
 ```
 
 ### Check tests and coverage...
-```commandline
+```shell
 python manager.py run-test
 python manager.py run-coverage
 ```

{core_https-1.1.1 → core_https-1.1.3}/core_https.egg-info/PKG-INFO

@@ -1,12 +1,13 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: core-https
-Version: 1.1.1
+Version: 1.1.3
 Summary: This project/library contains common elements related to HTTP & API services...
 Author-email: Alejandro Cora González <alek.cora.glez@gmail.com>
 Maintainer: Alejandro Cora González
 License: MIT
 Project-URL: Homepage, https://gitlab.com/bytecode-solutions/core/core-https
 Project-URL: Repository, https://gitlab.com/bytecode-solutions/core/core-https
+Project-URL: Documentation, https://core-https.readthedocs.io/en/latest/
 Project-URL: Issues, https://gitlab.com/bytecode-solutions/core/core-https/-/issues
 Project-URL: Changelog, https://gitlab.com/bytecode-solutions/core/core-https/-/blob/master/CHANGELOG.md
 Classifier: License :: OSI Approved :: MIT License
@@ -31,37 +32,42 @@ Requires-Dist: urllib3>=2.2.3; python_version >= "3.8"
 Requires-Dist: urllib3>=1.26.20; python_version >= "3.7" and python_version < "3.8"
 Requires-Dist: typing-extensions>=4.8.0; python_version >= "3.8" and python_version < "3.11"
 Requires-Dist: typing-extensions>=4.2.0; python_version >= "3.7" and python_version < "3.8"
+Provides-Extra: docs
+Requires-Dist: pydata-sphinx-theme==0.16.1; extra == "docs"
+Requires-Dist: Sphinx==8.2.3; extra == "docs"
+Dynamic: license-file
 
 # core-https
 _______________________________________________________________________________
 
-This project/library contains common elements related to HTTP & API services...
+This project/library contains common elements related to HTTP...
 
 ## Execution Environment
 
 ### Install libraries
-```commandline
+```shell
 pip install --upgrade pip 
 pip install virtualenv
 ```
 
 ### Create the Python Virtual Environment.
-```commandline
+```shell
+virtualenv --python={{python-version}} .venv
 virtualenv --python=python3.11 .venv
 ```
 
 ### Activate the Virtual Environment.
-```commandline
+```shell
 source .venv/bin/activate
 ```
 
 ### Install required libraries.
-```commandline
+```shell
 pip install .
 ```
 
 ### Check tests and coverage...
-```commandline
+```shell
 python manager.py run-test
 python manager.py run-coverage
 ```

{core_https-1.1.1 → core_https-1.1.3}/core_https.egg-info/SOURCES.txt

@@ -10,8 +10,6 @@ core_https.egg-info/SOURCES.txt
 core_https.egg-info/dependency_links.txt
 core_https.egg-info/requires.txt
 core_https.egg-info/top_level.txt
-core_https/decorators/__init__.py
-core_https/decorators/response_wrapper.py
 core_https/requesters/__init__.py
 core_https/requesters/base.py
 core_https/requesters/url_lib3.py

{core_https-1.1.1 → core_https-1.1.3}/core_https.egg-info/requires.txt

@@ -10,3 +10,7 @@ urllib3>=2.2.3
 
 [:python_version >= "3.8" and python_version < "3.11"]
 typing-extensions>=4.8.0
+
+[docs]
+pydata-sphinx-theme==0.16.1
+Sphinx==8.2.3

{core_https-1.1.1 → core_https-1.1.3}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "core-https"
 description = "This project/library contains common elements related to HTTP & API services..."
-version = "1.1.1"
+version = "1.1.3"
 
 authors = [
     {name = "Alejandro Cora González", email = "alek.cora.glez@gmail.com"}
@@ -49,11 +49,15 @@ dependencies = [
     "typing-extensions>=4.2.0; python_version >= '3.7' and python_version < '3.8'"
 ]
 
-#[project.optional-dependencies]
-#test = []
+[project.optional-dependencies]
+docs = [
+    "pydata-sphinx-theme==0.16.1",
+    "Sphinx==8.2.3"
+]
 
 [project.urls]
 Homepage = "https://gitlab.com/bytecode-solutions/core/core-https"
 Repository = "https://gitlab.com/bytecode-solutions/core/core-https"
+Documentation = "https://core-https.readthedocs.io/en/latest/"
 Issues = "https://gitlab.com/bytecode-solutions/core/core-https/-/issues"
 Changelog = "https://gitlab.com/bytecode-solutions/core/core-https/-/blob/master/CHANGELOG.md"

core_https-1.1.1/core_https/decorators/__init__.py

@@ -1,3 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from .response_wrapper import wrapp_response

core_https-1.1.1/core_https/decorators/response_wrapper.py

@@ -1,85 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from functools import wraps
-from typing import Any, Callable, Tuple
-
-try:
-    from http import HTTPStatus
-
-except ImportError:
-    from core_https.utils import HTTPStatus
-
-from core_https import StatusInfo
-from core_https.exceptions import AuthorizationException
-from core_https.exceptions import InternalServerError
-from core_https.exceptions import ServiceException
-
-
-def wrapp_response(fnc: Callable[..., Tuple[HTTPStatus, Any]]):
-    """
-    This decorator provides a generic mechanism to return the response payload
-    for the endpoints in the same format. This way each router or controller does not
-    need to take care of it. It returns the response into the below format...
-
-    Response payload:
-        {
-            "code": 2XX | 4XX | 5XX,
-            "status": "success" | "error" | "failure",
-            "result": ...
-            "error": ...,
-        }
-
-    Where:
-        code:
-            - 2XX -> For success responses.
-            - 4XX -> For service-managed errors.
-            - 5XX -> For unmanaged or internal server errors.
-
-        status:
-            Contains the text: "success", "failure", or "error". Where "failure" is for HTTP status
-            response values from 500 to 599, "error" is for statuses from 400 to 499, and "success" is
-            for everything else (e.g. 1XX, 2XX and 3XX responses).
-
-        result:
-            Contains the result.
-
-        error:
-            Only used for "failure" and "error" statuses, and it contains the error information.
-    """
-
-    @wraps(fnc)
-    def wrapper(*args, **kwargs):
-        try:
-            code, result = fnc(*args, **kwargs)
-
-            return {
-                "code": code,
-                "result": result,
-                "status": StatusInfo.SUCCESS
-            }
-
-        except (AuthorizationException, ServiceException) as error:
-            return {
-                "code": error.status_code,
-                "status": StatusInfo.ERROR,
-                "error": error.get_error_info()
-            }
-
-        except InternalServerError as error:
-            return {
-                "code": error.status_code,
-                "status": StatusInfo.FAILURE,
-                "error": error.get_error_info()
-            }
-
-        except Exception as error:
-            return {
-                "code": HTTPStatus.INTERNAL_SERVER_ERROR,
-                "status": StatusInfo.FAILURE,
-                "error": {
-                    "type": error.__class__.__name__,
-                    "details": str(error)
-                }
-            }
-
-    return wrapper