cardo-python-utils 0.4.2__tar.gz → 0.5.dev0__tar.gz

{cardo_python_utils-0.4.2/cardo_python_utils.egg-info → cardo_python_utils-0.5.dev0}/PKG-INFO

@@ -1,40 +1,49 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.4.2
+Version: 0.5.dev0
 Summary: Python library enhanced with a wide range of functions for different scenarios.
-Home-page: https://github.com/CardoAI/cardo-python-utils
-Author: Kristi Kotini
-Author-email: hello@cardoai.com
-License: MIT (X11)
+Author-email: Kristi Kotini <hello@cardoai.com>, Klajdi Çaushi <hello@cardoai.com>
+License: MIT
+Project-URL: Homepage, https://github.com/CardoAI/cardo-python-utils
+Project-URL: Repository, https://github.com/CardoAI/cardo-python-utils.git
+Project-URL: Issues, https://github.com/CardoAI/cardo-python-utils/issues
+Keywords: utilities,helpers,django
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
 License-File: LICENSE
-Provides-Extra: pandas
-Requires-Dist: pandas>=1.4.0; extra == "pandas"
 Provides-Extra: django
 Requires-Dist: Django; extra == "django"
-Requires-Dist: django-model-utils==4.2.0; extra == "django"
-Provides-Extra: rest
-Requires-Dist: djangorestframework; extra == "rest"
-Requires-Dist: requests; extra == "rest"
+Provides-Extra: django-ninja
+Requires-Dist: Django; extra == "django-ninja"
+Requires-Dist: django-ninja; extra == "django-ninja"
+Requires-Dist: PyJWT; extra == "django-ninja"
+Provides-Extra: drf
+Requires-Dist: Django; extra == "drf"
+Requires-Dist: djangorestframework; extra == "drf"
+Requires-Dist: PyJWT; extra == "drf"
+Provides-Extra: django-admin-auth
+Requires-Dist: Django; extra == "django-admin-auth"
+Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "django-admin-auth"
 Provides-Extra: all
 Requires-Dist: Django; extra == "all"
-Requires-Dist: pandas>=1.4.0; extra == "all"
-Requires-Dist: django-model-utils>=4.2.0; extra == "all"
-Requires-Dist: djangorestframework; extra == "all"
-Requires-Dist: requests; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5; extra == "dev"
+Requires-Dist: coverage>=6.0; extra == "dev"
+Requires-Dist: tox>=3.25; extra == "dev"
 Dynamic: license-file
 
 ============================
@@ -50,9 +59,7 @@ Main utils:
 * data_structures
 * db
 * django
-* django_rest
 * math
-* pandas
 * exception
 * choices
 
@@ -64,7 +71,7 @@ Quick start
     from python_utils.time import date_range
     date_range(start_date, end_date)
 
-Although the library provides some utility functions related to other libraries like django and pandas, it does not install any dependencies automatically.
+Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
 This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
 functions that depend on them.
 
@@ -74,7 +81,7 @@ You can also chose to install the dependencies alongside the library, including
 
 Tests
 -----
-The library has a 100% coverage by tests. If you want to see tests in action:
+The library has a high coverage by tests. If you want to see tests in action:
 
 1. Inside venv, run  ``pip install -r tests/requirements.txt``
 

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.dev0}/README.rst

@@ -11,9 +11,7 @@ Main utils:
 * data_structures
 * db
 * django
-* django_rest
 * math
-* pandas
 * exception
 * choices
 
@@ -25,7 +23,7 @@ Quick start
     from python_utils.time import date_range
     date_range(start_date, end_date)
 
-Although the library provides some utility functions related to other libraries like django and pandas, it does not install any dependencies automatically.
+Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
 This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
 functions that depend on them.
 
@@ -35,7 +33,7 @@ You can also chose to install the dependencies alongside the library, including
 
 Tests
 -----
-The library has a 100% coverage by tests. If you want to see tests in action:
+The library has a high coverage by tests. If you want to see tests in action:
 
 1. Inside venv, run  ``pip install -r tests/requirements.txt``
 

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.dev0/cardo_python_utils.egg-info}/PKG-INFO

@@ -1,40 +1,49 @@
 Metadata-Version: 2.4
 Name: cardo-python-utils
-Version: 0.4.2
+Version: 0.5.dev0
 Summary: Python library enhanced with a wide range of functions for different scenarios.
-Home-page: https://github.com/CardoAI/cardo-python-utils
-Author: Kristi Kotini
-Author-email: hello@cardoai.com
-License: MIT (X11)
+Author-email: Kristi Kotini <hello@cardoai.com>, Klajdi Çaushi <hello@cardoai.com>
+License: MIT
+Project-URL: Homepage, https://github.com/CardoAI/cardo-python-utils
+Project-URL: Repository, https://github.com/CardoAI/cardo-python-utils.git
+Project-URL: Issues, https://github.com/CardoAI/cardo-python-utils/issues
+Keywords: utilities,helpers,django
 Classifier: Environment :: Web Environment
 Classifier: Framework :: Django
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: BSD License
+Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Requires-Python: >=3.8
+Description-Content-Type: text/x-rst
 License-File: LICENSE
-Provides-Extra: pandas
-Requires-Dist: pandas>=1.4.0; extra == "pandas"
 Provides-Extra: django
 Requires-Dist: Django; extra == "django"
-Requires-Dist: django-model-utils==4.2.0; extra == "django"
-Provides-Extra: rest
-Requires-Dist: djangorestframework; extra == "rest"
-Requires-Dist: requests; extra == "rest"
+Provides-Extra: django-ninja
+Requires-Dist: Django; extra == "django-ninja"
+Requires-Dist: django-ninja; extra == "django-ninja"
+Requires-Dist: PyJWT; extra == "django-ninja"
+Provides-Extra: drf
+Requires-Dist: Django; extra == "drf"
+Requires-Dist: djangorestframework; extra == "drf"
+Requires-Dist: PyJWT; extra == "drf"
+Provides-Extra: django-admin-auth
+Requires-Dist: Django; extra == "django-admin-auth"
+Requires-Dist: mozilla-django-oidc>=4.0.1; extra == "django-admin-auth"
 Provides-Extra: all
 Requires-Dist: Django; extra == "all"
-Requires-Dist: pandas>=1.4.0; extra == "all"
-Requires-Dist: django-model-utils>=4.2.0; extra == "all"
-Requires-Dist: djangorestframework; extra == "all"
-Requires-Dist: requests; extra == "all"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5; extra == "dev"
+Requires-Dist: coverage>=6.0; extra == "dev"
+Requires-Dist: tox>=3.25; extra == "dev"
 Dynamic: license-file
 
 ============================
@@ -50,9 +59,7 @@ Main utils:
 * data_structures
 * db
 * django
-* django_rest
 * math
-* pandas
 * exception
 * choices
 
@@ -64,7 +71,7 @@ Quick start
     from python_utils.time import date_range
     date_range(start_date, end_date)
 
-Although the library provides some utility functions related to other libraries like django and pandas, it does not install any dependencies automatically.
+Although the library provides some utility functions related to other libraries like django, it does not install any dependencies automatically.
 This means, you can install the library even if you do not use these libraries, but keep in mind that in this case you cannot use the
 functions that depend on them.
 
@@ -74,7 +81,7 @@ You can also chose to install the dependencies alongside the library, including
 
 Tests
 -----
-The library has a 100% coverage by tests. If you want to see tests in action:
+The library has a high coverage by tests. If you want to see tests in action:
 
 1. Inside venv, run  ``pip install -r tests/requirements.txt``
 

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.dev0}/cardo_python_utils.egg-info/SOURCES.txt

@@ -1,8 +1,7 @@
 LICENSE
 MANIFEST.in
 README.rst
-setup.cfg
-setup.py
+pyproject.toml
 cardo_python_utils.egg-info/PKG-INFO
 cardo_python_utils.egg-info/SOURCES.txt
 cardo_python_utils.egg-info/dependency_links.txt
@@ -12,13 +11,15 @@ python_utils/__init__.py
 python_utils/choices.py
 python_utils/data_structures.py
 python_utils/db.py
-python_utils/django_utils.py
 python_utils/esma_choices.py
 python_utils/exceptions.py
 python_utils/imports.py
 python_utils/math.py
-python_utils/pandas_utils.py
-python_utils/rest.py
 python_utils/text.py
 python_utils/time.py
-python_utils/types_hinting.py
+python_utils/types_hinting.py
+python_utils/django/utils.py
+python_utils/django/auth/__init__.py
+python_utils/django/auth/admin.py
+python_utils/django/auth/drf.py
+python_utils/django/auth/ninja.py

cardo_python_utils-0.5.dev0/cardo_python_utils.egg-info/requires.txt

@@ -0,0 +1,26 @@
+
+[all]
+Django
+
+[dev]
+pytest>=7.0
+pytest-django>=4.5
+coverage>=6.0
+tox>=3.25
+
+[django]
+Django
+
+[django-admin-auth]
+Django
+mozilla-django-oidc>=4.0.1
+
+[django-ninja]
+Django
+django-ninja
+PyJWT
+
+[drf]
+Django
+djangorestframework
+PyJWT

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.dev0}/cardo_python_utils.egg-info/top_level.txt

@@ -1 +1,2 @@
+dist
 python_utils

cardo_python_utils-0.5.dev0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cardo-python-utils"
+version = "0.5.dev0"
+description = "Python library enhanced with a wide range of functions for different scenarios."
+readme = "README.rst"
+requires-python = ">=3.8"
+license = {text = "MIT"}
+authors = [
+    {name = "Kristi Kotini", email = "hello@cardoai.com"},
+    {name = "Klajdi Çaushi", email = "hello@cardoai.com"}
+]
+keywords = ["utilities", "helpers", "django"]
+classifiers = [
+    "Environment :: Web Environment",
+    "Framework :: Django",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dependencies = []
+
+[project.optional-dependencies]
+django = [
+    "Django",
+]
+django-ninja = [
+    "Django",
+    "django-ninja",
+    "PyJWT",
+]
+drf = [
+    "Django",
+    "djangorestframework",
+    "PyJWT",
+]
+django-admin-auth = [
+    "Django",
+    "mozilla-django-oidc>=4.0.1",
+]
+all = [
+    "Django",
+]
+dev = [
+    "pytest>=7.0",
+    "pytest-django>=4.5",
+    "coverage>=6.0",
+    "tox>=3.25",
+]
+
+[project.urls]
+Homepage = "https://github.com/CardoAI/cardo-python-utils"
+Repository = "https://github.com/CardoAI/cardo-python-utils.git"
+Issues = "https://github.com/CardoAI/cardo-python-utils/issues"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+where = ["."]
+exclude = ["tests", "tests.*"]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+django_find_project = false
+python_files = ["tests.py", "test_*.py", "*_tests.py"]
+addopts = "--strict-markers --no-migrations --reuse-db --log-cli-level=INFO --doctest-modules"
+
+[tool.tox]
+legacy_tox_ini = "tox.ini"

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.dev0}/python_utils/choices.py

@@ -76,7 +76,7 @@ class ChoiceEnum(Enum, metaclass=ChoiceEnumMeta):
 
     @classmethod
     def get_by_value(cls, value: str | int):
-        value_index = 0 if type(value) == int else 1
+        value_index = 0 if isinstance(value, int) else 1
         return next((v for v in cls.__members__.values() if v.value[value_index] == value), None)
 
     @classmethod

cardo_python_utils-0.5.dev0/python_utils/django/auth/admin.py

@@ -0,0 +1,49 @@
+from django.conf import settings
+from mozilla_django_oidc.auth import OIDCAuthenticationBackend
+
+
+class OIDCCustomAuthenticationBackend(OIDCAuthenticationBackend):
+    def _get_user_data(self, claims) -> dict:
+        client_roles = (
+            claims.get("resource_access", {})
+            .get(getattr(settings, "OIDC_RP_CLIENT_ID", ""), {})
+            .get("roles", [])
+        )
+        is_superuser = "Admin" in client_roles
+
+        return {
+            "username": claims.get("preferred_username"),
+            "email": claims.get("email"),
+            "first_name": claims.get("given_name", ""),
+            "last_name": claims.get("family_name", ""),
+            "is_staff": claims.get("is_staff", False),
+            "is_superuser": is_superuser,
+        }
+
+    def filter_users_by_claims(self, claims):
+        username = claims.get("preferred_username")
+        if not username:
+            return self.UserModel.objects.none()
+        return self.UserModel.objects.filter(username=username)
+
+    def create_user(self, claims):
+        return self.UserModel.objects.create_user(**self._get_user_data(claims))
+
+    def update_user(self, user, claims):
+        save_needed = False
+
+        for attr, value in self._get_user_data(claims).items():
+            if getattr(user, attr) != value:
+                setattr(user, attr, value)
+                save_needed = True
+
+        if save_needed:
+            user.save()
+
+        return user
+
+
+def has_permission(request):
+    # The user does not need to be staff to access the admin site
+    # Only superusers will have access to do anything in the admin site
+    return request.user.is_active and request.user.is_superuser

cardo_python_utils-0.5.dev0/python_utils/django/auth/drf.py

@@ -0,0 +1,117 @@
+import jwt
+
+from django.conf import settings
+from django.contrib.auth import get_user_model
+from jwt import PyJWKClient
+from jwt.exceptions import InvalidTokenError
+
+from rest_framework import authentication
+from rest_framework.exceptions import AuthenticationFailed
+from rest_framework.permissions import BasePermission
+
+
+jwks_client = PyJWKClient(getattr(settings, "JWKS_URL", ""))
+
+
+class AuthenticationBackend(authentication.TokenAuthentication):
+    keyword = "Bearer"
+
+    def authenticate_credentials(self, token: str):
+        signing_key = jwks_client.get_signing_key_from_jwt(token)
+
+        try:
+            payload = jwt.decode(
+                token,
+                signing_key.key,
+                algorithms=["RS256"],
+                audience=getattr(settings, "JWT_AUDIENCE", None),
+            )
+        except InvalidTokenError as e:
+            raise AuthenticationFailed(f"Invalid token: {str(e)}") from e
+
+        try:
+            username = payload["preferred_username"]
+        except KeyError as e:
+            raise AuthenticationFailed(
+                "Invalid token: preferred_username not present."
+            ) from e
+
+        user = self._get_user(username, payload)
+        return user, payload
+
+    def _get_user(self, username: str, payload: dict):
+        """
+        Get or create a user based on the JWT payload.
+        If the user exists, update their details.
+        """
+        user_model = get_user_model()
+        user_data = {
+            "first_name": payload.get("given_name") or "",
+            "last_name": payload.get("family_name") or "",
+            "email": payload.get("email") or "",
+            "is_staff": payload.get("is_staff", False),
+        }
+        if hasattr(user_model, "is_demo"):
+            user_data["is_demo"] = payload.get("is_demo", False)
+
+        user = user_model.objects.filter(username=username).first()
+        if user:
+            update_needed = False
+
+            for field, value in user_data.items():
+                if getattr(user, field) != value:
+                    setattr(user, field, value)
+                    update_needed = True
+
+            if update_needed:
+                user.save(update_fields=list(user_data.keys()))
+
+            return user
+        else:
+            return user_model.objects.create(
+                username=username,
+                **user_data,
+            )
+
+
+class HasScope(BasePermission):
+    """
+    Permission class to check for allowed scopes in the access token.
+
+    This permission class checks if any of the scopes defined in the `allowed_scopes`
+    attribute of the view are present in the 'scope' claim of the access token.
+
+    Example Usage in a View:
+
+    class MyApiView(APIView):
+        permission_classes = [IsAuthenticated, HasScope]
+        allowed_scopes = ["jobs"]
+        ...
+
+    If no particular scope is required, you can set `allowed_scopes = "*"`
+        to allow access without scope checks.
+    """
+
+    def has_permission(self, request, view):
+        allowed_scopes = getattr(view, "allowed_scopes", [])
+
+        if not allowed_scopes:
+            raise Exception(
+                f"No allowed_scopes defined on the view '{view.__class__.__name__}'. "
+                "Define allowed_scopes or set it to '*' to allow any scope."
+            )
+
+        if allowed_scopes == "*":
+            return True
+
+        if not request.auth or "scope" not in request.auth:
+            return False
+
+        token_scopes_str = request.auth.get("scope", "")
+        token_scopes = set(token_scopes_str.split())
+
+        for scope in allowed_scopes:
+            if f"{getattr(settings, 'JWT_SCOPE_PREFIX', '')}:{scope}" in token_scopes:
+                return True
+
+        return False

cardo_python_utils-0.5.dev0/python_utils/django/auth/ninja.py

@@ -0,0 +1,128 @@
+from typing import Literal
+
+from jwt import PyJWKClient, decode as jwt_decode
+from jwt.exceptions import InvalidTokenError
+
+from django.conf import settings
+from django.contrib.auth import get_user_model
+from ninja.security import HttpBearer
+from ninja.errors import AuthenticationError, HttpError
+
+jwks_client = PyJWKClient(getattr(settings, "JWKS_URL", ""))
+
+
+class AuthBearer(HttpBearer):
+    def authenticate(self, request, token):
+        signing_key = jwks_client.get_signing_key_from_jwt(token)
+
+        try:
+            payload = jwt_decode(
+                token,
+                signing_key.key,
+                algorithms=["RS256"],
+                audience=getattr(settings, "JWT_AUDIENCE", None),
+            )
+        except InvalidTokenError as e:
+            raise AuthenticationError(f"Invalid token: {str(e)}") from e
+
+        try:
+            username = payload["preferred_username"]
+        except KeyError as e:
+            raise AuthenticationError(
+                "Invalid token: preferred_username not present."
+            ) from e
+
+        user = self._get_user(username, payload)
+
+        self._verify_scopes(request, payload)
+
+        return user
+
+    def _get_user(self, username: str, payload: dict):
+        """
+        Get or create a user based on the JWT payload.
+        If the user exists, update their details.
+        """
+        user_model = get_user_model()
+        user_data = {
+            "first_name": payload.get("given_name") or "",
+            "last_name": payload.get("family_name") or "",
+            "email": payload.get("email") or "",
+            "is_staff": payload.get("is_staff", False),
+        }
+        if hasattr(user_model, "is_demo"):
+            user_data["is_demo"] = payload.get("is_demo", False)
+
+        user = user_model.objects.filter(username=username).first()
+        if user:
+            update_needed = False
+
+            for field, value in user_data.items():
+                if getattr(user, field) != value:
+                    setattr(user, field, value)
+                    update_needed = True
+
+            if update_needed:
+                user.save(update_fields=list(user_data.keys()))
+
+            return user
+        else:
+            return user_model.objects.create(
+                username=username,
+                **user_data,
+            )
+
+    def _verify_scopes(self, request, token_payload):
+        allowed_scopes = self._get_view_allowed_scopes(request)
+
+        if allowed_scopes == "*":
+            return
+
+        token_scopes_str = token_payload.get("scope", "")
+        token_scopes = set(token_scopes_str.split())
+
+        for scope in allowed_scopes:
+            if f"{getattr(settings, 'JWT_SCOPE_PREFIX', '')}:{scope}" in token_scopes:
+                return
+
+        raise HttpError(403, "You are not allowed to access this resource.")
+
+    def _get_view_allowed_scopes(self, request):
+        view_function = self._get_view_function(request)
+        scopes = getattr(view_function, "_allowed_scopes", None)
+
+        if scopes is None:
+            raise Exception(
+                f"No allowed_scopes defined on the view {view_function.__name__}."
+                "Add the decorator @allowed_scopes([...]) or @allowed_scopes('*') to the view."
+            )
+
+        return scopes
+
+    def _get_view_function(self, request):
+        view_func = request.resolver_match.func.__self__
+        method = request.method.upper()
+        for operation in view_func.operations:
+            if operation.methods and method in operation.methods:
+                return operation.view_func
+
+        raise Exception(
+            f"Could not determine the view function for {request.method} {request.path}."
+        )
+
+
+def allowed_scopes(scopes: list[str] | Literal["*"]):
+    """
+    A decorator that attaches a list of required scopes to a view function
+    in the attribute `_allowed_scopes`.
+    This is used by a global authenticator to perform authorization checks.
+    """
+
+    def decorator(view_func):
+        if not isinstance(scopes, list) and scopes != "*":
+            raise ValueError("scopes must be a list of strings or '*'")
+
+        setattr(view_func, "_allowed_scopes", scopes)
+        return view_func
+
+    return decorator

cardo_python_utils-0.4.2/python_utils/django_utils.py → cardo_python_utils-0.5.dev0/python_utils/django/utils.py

@@ -64,25 +64,6 @@ def record_to_dict(record: Model_T, exclude: List = None) -> Dict:
     return initial_data
 
 
-def get_choices_list_and_dict(choices) -> Tuple[List, Dict]:
-    """
-    From a Choices object return a list and dict of these choices.
-    Args:
-        choices: Choices object to get the representations from
-    Returns:
-        tuple of list with human_value and dict-> {human_value: value}
-    Examples:
-        >>> from model_utils import Choices
-        >>> get_choices_list_and_dict(Choices((1, 'hello', 'HELLO')))
-        ([('HELLO', 'HELLO')], {'HELLO': 1})
-    """
-    import_optional_dependency('model_utils', dependency='django-model-utils')
-
-    choices_list = [(human_value, human_value) for _, human_value in choices]
-    choices_dict = {human_value: value for value, human_value in choices}
-    return choices_list, choices_dict
-
-
 def perform_query(
         sql_query: str,
         params: Optional[List] = None,
@@ -236,25 +217,6 @@ def update_record(record: Model_T, save=True, **data) -> Model_T:
     return record
 
 
-def get_choice_value(choices, human_string: str) -> Optional[Union[int, str]]:
-    """
-    Get database representation of a choice for a human-readable value
-
-    Args:
-        choices: model_utils Choice object to get the db value from
-        human_string: string representing the human-readable value
-    Returns:
-        db representation of choice field
-    """
-
-    import_optional_dependency('model_utils', dependency='django-model-utils')
-
-    for value, representation in choices:
-        if representation == human_string:
-            return value
-    return None
-
-
 def get_or_none(records: models.QuerySet, *args, **kwargs) -> Optional[Model_T]:
     """
     Wrapper around queryset.get to return None if no record is found

{cardo_python_utils-0.4.2 → cardo_python_utils-0.5.dev0}/python_utils/text.py

@@ -1,6 +1,5 @@
 import hashlib
 import re
-from decimal import Decimal
 from typing import Optional, List, Any
 
 from python_utils.types_hinting import NumberIFD
@@ -19,6 +18,7 @@ def format_percent(value: Optional[NumberIFD]):
         '1300%'
         >>> format_percent(0.13)
         '13.0%'
+        >>> from decimal import Decimal
         >>> format_percent(Decimal('0.123456'))
         '12.35%'
     """
@@ -37,6 +37,7 @@ def format_currency(value: Optional[NumberIFD], symbol: str) -> Optional[str]:
     Examples:
         >>> format_currency(120.1234, 'EUR')
         'EUR120.12'
+        >>> from decimal import Decimal
         >>> format_currency(Decimal('120.1234'), 'EUR')
         'EUR120.12'
         >>> format_currency(None, 'EUR') is None
@@ -63,7 +64,7 @@ def human_string(text: str) -> str:
     """
     if not text:
         return ""
-    return ' '.join(word.title() for word in text.split('_'))
+    return " ".join(word.title() for word in text.split("_"))
 
 
 camel_case_pattern = re.compile(r"(?<!^)(?=[A-Z])")
@@ -141,5 +142,5 @@ def create_hash(data: List[Any]) -> str:
         >>> create_hash(['test', 'hash', 1])
         '5ca1b365312e58a36bb985fc770a490b'
     """
-    merged_data = '-'.join([str(rec) for rec in data])
-    return hashlib.md5(merged_data.encode('utf-8')).hexdigest()
+    merged_data = "-".join([str(rec) for rec in data])
+    return hashlib.md5(merged_data.encode("utf-8")).hexdigest()

cardo_python_utils-0.5.dev0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cardo_python_utils-0.4.2/cardo_python_utils.egg-info/requires.txt

@@ -1,18 +0,0 @@
-
-[all]
-Django
-pandas>=1.4.0
-django-model-utils>=4.2.0
-djangorestframework
-requests
-
-[django]
-Django
-django-model-utils==4.2.0
-
-[pandas]
-pandas>=1.4.0
-
-[rest]
-djangorestframework
-requests

cardo_python_utils-0.4.2/python_utils/pandas_utils.py

@@ -1,143 +0,0 @@
-from datetime import date, datetime
-from typing import List, Dict, Union, Literal
-
-import pandas as pd
-
-from python_utils.time import get_date, last_day_of_month
-
-
-def unique_not_null_values(df: pd.DataFrame, column: str) -> List:
-    """
-    Get a list with unique values from the values of a dataframe column
-    1. Filter the df to keep rows with notnull values in the given column
-    2. Return a list with all the values of the column appearing only once
-
-    Args:
-        df: dataframe object we are getting the unique values from
-        column: the column name on which we are looking for the unique values
-    Returns:
-        list with all unique values
-    Examples:
-        >>> test_df = pd.DataFrame({'col1': [1, None, 1, 3, 2], 'col2': [3, 7, 4, 1, 3]})
-        >>> unique_not_null_values(test_df, 'col1')
-        [1.0, 3.0, 2.0]
-    """
-    return df[df[column].notnull()][column].unique().tolist()
-
-
-def rename_and_replace_column_information(df: pd.DataFrame, data: Dict) -> pd.DataFrame:
-    """
-    We use this mostly when we serialize the data from postgres.
-    It replaces the column values with a dictionary and also renames the column names.
-    Performs a rename of the columns
-
-    Args:
-        df: Pandas Data Frame
-        data: data that maps columns and replacement/mapping as in example:
-            {
-            'column_in_pandas': {
-                'replace_to': 'new_column_name',
-                'map': {
-                    1: 2,
-                    2: 3
-                }
-            }
-    Returns:
-        New Modified Pandas Dataframe.
-    Examples:
-        >>> test_df = pd.DataFrame({'col1': ['a', 'b'], 'col2': [1, 2]})
-        >>> rename_and_replace_column_information(test_df, {'col1': {'replace_to': 'new', 'map': {'a': 1}}})
-          new  col2
-        0   1     1
-        1   b     2
-        >>> test_df = pd.DataFrame({'col1': ['a', 'b'], 'col2': [1, 2]})
-        >>> rename_and_replace_column_information(test_df, {})
-          col1  col2
-        0    a     1
-        1    b     2
-    """
-    map_data = {key: value.get('map') for key, value in data.items()}
-    if map_data:
-        df.replace(map_data, inplace=True)
-
-    rename_columns = {key: value.get('replace_to') for key, value in data.items()}
-    if rename_columns:
-        df.rename(columns=rename_columns, inplace=True)
-    return df
-
-
-def get_dates_between(
-        start_date: Union[date, datetime, str],
-        end_date: Union[date, datetime, str],
-        inclusive: Literal["both", "neither", "left", "right"] = "both"
-) -> List[date]:
-    """
-    1. Give start and end dates.
-    2. Set inclusive if you want, by default the value is both
-    3. Return list of dates
-    Args:
-        start_date (date, datetime, str): The left bound for the date generation by pandas
-        end_date (date, datetime, str): The right bound for the date generation by pandas
-        inclusive: Include boundaries; Whether to set each bound as closed or open
-    Returns:
-        list of date obj representing the dates in between the start and end
-    Raises:
-        ValueError: if one of passed dates is str and not well formatted to be converted to date obj
-        Examples:
-        >>> get_dates_between(date(2021, 2, 1), date(2021, 2, 3))
-        [datetime.date(2021, 2, 1), datetime.date(2021, 2, 2), datetime.date(2021, 2, 3)]
-        >>> get_dates_between(datetime(2021, 2, 1, 0, 0), datetime(2021, 2, 3, 0, 0))
-        [datetime.date(2021, 2, 1), datetime.date(2021, 2, 2), datetime.date(2021, 2, 3)]
-        >>> get_dates_between("2021-2-1", "2021-2-3")
-        [datetime.date(2021, 2, 1), datetime.date(2021, 2, 2), datetime.date(2021, 2, 3)]
-        >>> get_dates_between(date(2021, 2, 1), date(2021, 2, 3), inclusive="right")
-        [datetime.date(2021, 2, 2), datetime.date(2021, 2, 3)]
-        >>> get_dates_between("2021-2-1-1-1", "2021-3-1-1-1-1")
-        Traceback (most recent call last):
-        ...
-        ValueError: Invalid date 2021-2-1-1-1
-    """
-    start_date = get_date(start_date, raise_error=True)
-    end_date = get_date(end_date, raise_error=True)
-    dates_range = pd.date_range(start=start_date, end=end_date, inclusive=inclusive).tolist()
-    return [date(d.year, d.month, d.day) for d in dates_range]
-
-
-def get_months_between_dates(
-        start_date: Union[date, datetime, str],
-        end_date: Union[date, datetime, str],
-        inclusive: Literal["both", "neither", "left", "right"] = "both"
-) -> List[date]:
-    """
-    Get a timestamp for each month between the two dates.
-    The start_date is appended because the pandas list begins from the next month
-
-    Args:
-        start_date (date, datetime, str): The left bound for the date generation by pandas
-        end_date (date, datetime, str): The right bound for the date generation by pandas
-        inclusive: Include boundaries; Whether to set each bound as closed or open
-    Returns:
-        list of date obj representing the end date of each month in between
-    Raises:
-        ValueError: if one of passed dates is str and not well formatted to be converted to date obj
-    Examples:
-        >>> get_months_between_dates(date(2021, 2, 1), date(2021, 3, 1))
-        [datetime.date(2021, 2, 28), datetime.date(2021, 3, 31)]
-        >>> get_months_between_dates(datetime(2021, 2, 1, 0, 0), datetime(2021, 3, 1, 1, 1))
-        [datetime.date(2021, 2, 28), datetime.date(2021, 3, 31)]
-        >>> get_months_between_dates("2021-2-1", "2021-3-1")
-        [datetime.date(2021, 2, 28), datetime.date(2021, 3, 31)]
-        >>> get_months_between_dates(date(2021, 2, 1), date(2021, 3, 1), inclusive="right")
-        [datetime.date(2021, 3, 31)]
-        >>> get_months_between_dates("2021-2-1-1-1", "2021-3-1-1-1-1")
-        Traceback (most recent call last):
-        ...
-        ValueError: Invalid date 2021-2-1-1-1
-    """
-    start_date = get_date(start_date, raise_error=True)
-    end_date = get_date(end_date, raise_error=True)
-    dates_range = pd.date_range(start_date, end_date, freq="MS", inclusive=inclusive).to_list()
-    return [
-        last_day_of_month(year=cur_month.year, month=cur_month.month)
-        for cur_month in dates_range
-    ]

cardo_python_utils-0.4.2/python_utils/rest.py

@@ -1,37 +0,0 @@
-from urllib.parse import urlencode
-
-from rest_framework.response import Response
-from rest_framework.status import HTTP_400_BAD_REQUEST, HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN, \
-    HTTP_502_BAD_GATEWAY
-
-
-def bad_request(message="Bad request."):  # pragma no cover
-    return Response(data={"message": message}, status=HTTP_400_BAD_REQUEST)
-
-
-def unauthorized(message="Unauthorized."):  # pragma no cover
-    return Response(data={"message": message}, status=HTTP_401_UNAUTHORIZED)
-
-
-def forbidden(message="Forbidden."):  # pragma no cover
-    return Response(data={"message": message}, status=HTTP_403_FORBIDDEN)
-
-
-def bad_gateway(message="Bad Gateway."):  # pragma no cover
-    return Response(data={"message": message}, status=HTTP_502_BAD_GATEWAY)
-
-
-def add_params_to_url(url: str, **kwargs) -> str:
-    """
-    Join the url and params ready for making requests
-
-    Args:
-        url: string representing the url to be called
-        **kwargs: all the params to join the url
-    Returns:
-        Final url ready for request
-    Examples:
-        >>> add_params_to_url('https://test.com', p1='20', p2=30, p3=None, p4='test', p5='<html/>')
-        'https://test.com?p1=20&p2=30&p3=None&p4=test&p5=%3Chtml%2F%3E'
-    """
-    return url if not kwargs else f"{url}?{urlencode(kwargs)}"

cardo_python_utils-0.4.2/setup.cfg

@@ -1,44 +0,0 @@
-[metadata]
-name = cardo-python-utils
-version = 0.4.2
-description = Python library enhanced with a wide range of functions for different scenarios.
-long_description = file: README.rst
-url = https://github.com/CardoAI/cardo-python-utils
-author = Kristi Kotini
-author_email = hello@cardoai.com
-license = MIT (X11)
-classifiers = 
-	Environment :: Web Environment
-	Framework :: Django
-	Intended Audience :: Developers
-	License :: OSI Approved :: BSD License
-	Operating System :: OS Independent
-	Programming Language :: Python
-	Programming Language :: Python :: 3
-	Programming Language :: Python :: 3 :: Only
-	Programming Language :: Python :: 3.8
-	Programming Language :: Python :: 3.9
-	Programming Language :: Python :: 3.10
-	Topic :: Internet :: WWW/HTTP
-	Topic :: Internet :: WWW/HTTP :: Dynamic Content
-
-[options]
-include_package_data = true
-packages = find:
-python_requires = >=3.8
-
-[options.extras_require]
-pandas = pandas>=1.4.0
-django = Django; django-model-utils==4.2.0
-rest = djangorestframework; requests
-all = 
-	Django
-	pandas>=1.4.0
-	django-model-utils>=4.2.0
-	djangorestframework
-	requests
-
-[egg_info]
-tag_build = 
-tag_date = 0
-

cardo_python_utils-0.4.2/setup.py

@@ -1,7 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name="cardo-python-utils",
-    packages=find_packages(exclude=["tests.*", "tests"]),
-    include_package_data=True
-)